Projects

List projects

Returns the projects that group orders and work, cursor-paginated.

Tool

filmo_projects_list

Readprojects:read

projects:read
120/min
Server annotation: Read-only
Server annotation: Idempotent

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "filmo_projects_list",
    "arguments": {
      "limit": 20
    }
  }
}

{
  "structuredContent": {
    "data": [
      {
        "id": "id_8f2a1c",
        "projectNumber": "<projectNumber>",
        "name": "Example",
        "color": "<color>",
        "externalReference": "<externalReference>",
        "projectTypeId": "proj_8f2a1c",
        "projectType": {
          "id": "id_8f2a1c",
          "name": "Example",
          "color": "<color>"
        },
        "contact": {
          "id": "id_8f2a1c",
          "name": "Example"
        },
        "location": {
          "name": "Example",
          "address": "<address>",
          "city": "<city>",
          "postalCode": "<postalCode>",
          "province": "<province>",
          "country": "ES",
          "lat": 1,
          "lng": 1
        },
        "startDate": "2026-09-01T08:00:00Z",
        "endDate": "2026-09-01T08:00:00Z",
        "status": "draft",
        "archived": true,
        "orderIds": [
          "orde_8f2a1c"
        ],
        "totalOrders": 1,
        "tags": [
          {
            "id": "id_8f2a1c",
            "name": "Example"
          }
        ],
        "customFields": {
          "key": "<key>"
        },
        "source": "<source>",
        "createdAt": "2026-09-01T08:00:00Z",
        "updatedAt": "2026-09-01T08:00:00Z"
      }
    ],
    "pagination": {
      "nextCursor": "eyJvIjo1MH0",
      "hasMore": true,
      "total": 1
    },
    "meta": {
      "rateLimit": {
        "limit": 120,
        "remaining": 119,
        "reset": 42
      }
    }
  }
}

generated from the schema

Tenancy inherited from the parent account: a billing account also sees the projects of its parent account.

Arguments

limitintegerdefault:50

Page size (1-500). Defaults to 50.

Limits: min 1, max 500

cursorstring

Opaque cursor of the page to return. Pass the value of pagination.nextCursor from the previous response; treat it as opaque.

Limits: max length 200

qstring

Free-text search on the name and the external reference.

Limits: min length 1, max length 200

sortstring

Sort order: up to 3 comma-separated fields, each with a leading "-" for descending (e.g. "-updatedAt,name"). Sortable fields: createdAt, updatedAt, name, projectNumber, startDate, endDate, status. Defaults to "-createdAt". Ties are broken by id, so the order is stable across pages, and a cursor is bound to the sort it was issued with.

Limits: max length 200

statusstring

Filter by project status: draft, budgeted, confirmed, in_progress, invoiced, completed, cancelled or archived (legacy status present in old data).

Available options: draft, budgeted, confirmed, in_progress, invoiced, completed, cancelled, archived

contactIdstring

Filter by project contact identifier.

Limits: min length 1, max length 100

projectTypeIdstring

Filter by project type identifier.

Limits: min length 1, max length 100

archivedboolean

Filter by archived: "true" lists ONLY archived projects; "false" (or absent) excludes them from the listing.

includeTotalbooleandefault:false

Set it to true to include pagination.total, the number of results that match the filters across all pages. Off by default.

dateFiltersobject

Date filters by field. A bare day (YYYY-MM-DD) is read in the business timezone; an ISO 8601 instant with offset is applied as is by gte, lte, gt and lt, while on widens it to the whole business day that contains it. Fields: created, updated.

Show child attributes

dateFilters.createdobject

Show child attributes

dateFilters.created.gtestring

From this day or instant, inclusive.

dateFilters.created.ltestring

Up to this day or instant, inclusive.

dateFilters.created.gtstring

Strictly after; a bare day means after the end of that day.

dateFilters.created.ltstring

Strictly before; a bare day means before the start of that day.

dateFilters.created.onstring

Exactly that day; an instant means the whole business day that contains it.

dateFilters.updatedobject

Show child attributes

dateFilters.updated.gtestring

From this day or instant, inclusive.

dateFilters.updated.ltestring

Up to this day or instant, inclusive.

dateFilters.updated.gtstring

Strictly after; a bare day means after the end of that day.

dateFilters.updated.ltstring

Strictly before; a bare day means before the start of that day.

dateFilters.updated.onstring

Exactly that day; an instant means the whole business day that contains it.

Result

On success the result carries structuredContent with data and meta. These are the attributes of data.

Show the attributes of data

idstring

Unique project identifier.

projectNumberstring | null

Human-readable project number; null if not numbered.

namestring

Project name.

colorstring | null

Color associated with the project (for the UI); null if none.

externalReferencestring | null

External reference of the project (for example, from the customer system); null if not recorded.

projectTypeIdstring | null

Project type identifier; null if the project has no type.

projectTypeobject | null

Compact reference to the project type; null if none.

Show child attributes

projectType.idstring

Unique project type identifier.

projectType.namestring

Project type name.

projectType.colorstring | null

Color associated with the project type (for the UI); null if none.

contactobject | null

Compact reference to the project contact; null if none.

Show child attributes

contact.idstring

Unique contact identifier.

contact.namestring

Contact name.

locationobject

Project location; its inner fields are null when not recorded.

Show child attributes

location.namestring | null

Name of the place/location; null if not recorded.

location.addressstring | null

Address of the location; null if not recorded.

location.citystring | null

City of the location; null if not recorded.

location.postalCodestring | null

Postal code of the location; null if not recorded.

location.provincestring | null

Province or region of the location; null if not recorded.

location.countrystring | null

Country of the location; null if not recorded.

location.latnumber | null

Latitude of the location; null if not recorded.

location.lngnumber | null

Longitude of the location; null if not recorded.

startDatestring<date-time>

Project start date in ISO 8601 with offset.

endDatestring<date-time>

Project end date in ISO 8601 with offset.

statusstring

Project status: draft, budgeted, confirmed, in_progress, invoiced, completed, cancelled or archived. archived is a LEGACY status that appears in old data; the current archived state is expressed by the archived boolean of this same DTO.

Available options: draft, budgeted, confirmed, in_progress, invoiced, completed, cancelled, archived

archivedboolean

Whether the project is archived.

orderIdsstring[]

Identifiers of the project orders. Order details are obtained from GET /api/v1/orders?projectId=.

totalOrdersinteger

Total number of orders in the project (equals orderIds.length).

tagsobject[]

Tags attached to the project, with their identifier and name.

Show child attributes

tags.idstring

Unique identifier of the tag.

tags.namestring

Tag name.

customFieldsobject<string, any>

Custom field values by custom field identifier; the definitions are in /api/v1/custom-fields.

sourcestring | null

Source the project was created from; null if not recorded.

createdAtstring<date-time>

Creation date in ISO 8601 with offset.

updatedAtstring<date-time>

Last update date in ISO 8601 with offset.

An error is a result with isError: true and the problem in content[0].text; there is no structuredContent. See Errors.

Sample prompts

List the active projects and the number of orders in each.

The same operation by REST

This tool runs GET /api/v1/projects.

Projects
List projects
Returns the projects that group orders and work, cursor-paginated.
Guides
Safe writes
An assistant that can write can also write the wrong thing. Decide which tools need a person, retry without duplicating, and know what a write sets in motion.
Guides
Errors
A tool error is a result with isError: true and the problem in the first text block. Branch on its code.

Was this page helpful?

Result

Arguments

Result

Sample prompts

The same operation by REST

Related pages

List projects

Safe writes

Errors