*MCP › Reference › Rentals › Projects*

# Link an order to a project

> Hangs the order off the project.

It takes no body. It is idempotent: if it was already linked, nothing happens and the response is the same. An archived project does not admit new links and rejects the request. The order does not change customer or dates because of this. Returns the full project, the same projection as its GET.

TOOL `filmo_projects_orders_link` · `projects:write` · 120/min · Server annotation: Idempotent

## Arguments

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `projectId` | string | Yes | Project identifier. |
| `orderId` | string | Yes | Order identifier. |
| `idempotencyKey` | string | No | Idempotency key chosen by the client (a UUID is recommended). Repeating the same key with the same arguments within 24 h returns the stored response without executing again; with different arguments it responds 422. It is the safe way to retry after a network failure. |
| `ifMatch` | string | No | Optimistic locking: the meta.etag you got from the detail read of this resource (or "*"). If the resource changed since, the call fails with 412 precondition_failed before writing anything; read it again and retry. Omit it to write unconditionally. |

## Result

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

| Name | Type | Description |
| --- | --- | --- |
| `id` | string | Unique project identifier. |
| `projectNumber` | string | Human-readable project number; null if not numbered. |
| `name` | string | Project name. |
| `color` | string | Color associated with the project (for the UI); null if none. |
| `externalReference` | string | External reference of the project (for example, from the customer system); null if not recorded. |
| `projectTypeId` | string | Project type identifier; null if the project has no type. |
| `projectType` | object | Compact reference to the project type; null if none. |
| `projectType.id` | string | Unique project type identifier. |
| `projectType.name` | string | Project type name. |
| `projectType.color` | string | Color associated with the project type (for the UI); null if none. |
| `contact` | object | Compact reference to the project contact; null if none. |
| `contact.id` | string | Unique contact identifier. |
| `contact.name` | string | Contact name. |
| `location` | object | Project location; its inner fields are null when not recorded. |
| `location.name` | string | Name of the place/location; null if not recorded. |
| `location.address` | string | Address of the location; null if not recorded. |
| `location.city` | string | City of the location; null if not recorded. |
| `location.postalCode` | string | Postal code of the location; null if not recorded. |
| `location.province` | string | Province or region of the location; null if not recorded. |
| `location.country` | string | Country of the location; null if not recorded. |
| `location.lat` | number | Latitude of the location; null if not recorded. |
| `location.lng` | number | Longitude of the location; null if not recorded. |
| `startDate` | string<date-time> | Project start date in ISO 8601 with offset. |
| `endDate` | string<date-time> | Project end date in ISO 8601 with offset. |
| `status` | string | 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. `draft`, `budgeted`, `confirmed`, `in_progress`, `invoiced`, `completed`, `cancelled`, `archived` |
| `archived` | boolean | Whether the project is archived. |
| `orderIds` | string[] | Identifiers of the project orders. Order details are obtained from [`GET /api/v1/orders`](https://docs.filmo.io/rest-api/endpoint-reference/orders/list-orders)?projectId=. |
| `totalOrders` | integer | Total number of orders in the project (equals orderIds.length). |
| `tags` | object[] | Tags attached to the project, with their identifier and name. |
| `tags.id` | string | Unique identifier of the tag. |
| `tags.name` | string | Tag name. |
| `customFields` | object<string, any> | Custom field values by custom field identifier; the definitions are in `/api/v1/custom-fields`. |
| `source` | string | Source the project was created from; null if not recorded. |
| `createdAt` | string<date-time> | Creation date in ISO 8601 with offset. |
| `updatedAt` | string<date-time> | Last update date in ISO 8601 with offset. |

*Call · filmo_projects_orders_link*

```json
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "filmo_projects_orders_link",
    "arguments": {
      "projectId": "proj_8f2a1c",
      "orderId": "orde_8f2a1c"
    }
  }
}
```

*Result (generated from the schema)*

```json
{
  "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": {
      "idempotencyKey": "<the key you sent, or the one the server generated>",
      "rateLimit": {
        "limit": 120,
        "remaining": 119,
        "reset": 42
      }
    }
  }
}
```

## The same operation by REST

This tool runs [`POST /api/v1/projects/{projectId}/orders/{orderId}`](https://docs.filmo.io/rest-api/endpoint-reference/projects/link-an-order-to-a-project).

---

Canonical URL: https://docs.filmo.io/mcp/tools/projects/filmo-projects-orders-link  
Last updated: 2026-10-25