Projects

Get a project

Returns the detail of a project by its identifier.

Tool

filmo_projects_get

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_get",
    "arguments": {
      "projectId": "proj_8f2a1c"
    }
  }
}

{
  "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"
    },
    "meta": {
      "rateLimit": {
        "limit": 120,
        "remaining": 119,
        "reset": 42
      },
      "etag": "\"3sT3d9pBvZq4h2N0w8x1YkLmQ7c\""
    }
  }
}

generated from the schema

Arguments

projectIdstringRequired

Project identifier.

Limits: min length 1

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.

The same operation by REST

This tool runs GET /api/v1/projects/{projectId}.

Projects
Get a project
Returns the detail of a project by its identifier.
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

The same operation by REST

Related pages

Get a project

Safe writes

Errors