*REST API › Endpoint reference › Rentals › Projects*

# Get a project

> Returns the detail of a project by its identifier.

`GET /api/v1/projects/{projectId}` — scope `projects:read`

Scope: `projects:read` · 120/min · Inherited tenancy · If-None-Match · MCP: `filmo_projects_get`

## Authorizations

Bearer API key with the scope below. `projects:read`

## Headers

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `If-None-Match` | string | No | Conditional read: the `ETag` of the copy you already have. If the resource has not changed, the response is `304` with no body. |

## Path parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `projectId` | string | Yes | Project identifier. |

## Request examples

*Get a project*

**cURL**

```bash
curl https://app.filmo.io/api/v1/projects/proj_8f2a1c \
  --header "Authorization: Bearer $FILMO_API_KEY"
```

**Node.js**

```javascript
fetch('https://app.filmo.io/api/v1/projects/proj_8f2a1c', {
  headers: {
    Authorization: 'Bearer YOUR_FILMO_API_KEY'
  }
})
```

**Python**

```python
import requests

requests.get(
    "https://app.filmo.io/api/v1/projects/proj_8f2a1c",
    headers={
      "Authorization": "Bearer YOUR_FILMO_API_KEY"
    }
)
```

## Response

Response schema: `ProjectDetailDto`

| Status | Description |
| --- | --- |
| 200 | Successful response. |
| 304 | Not modified: the `If-None-Match` sent matches the current `ETag`. No body; the copy you have is current. |
| 401 | Authentication failed (unauthorized, api_key_invalid, api_key_revoked, api_key_expired, api_key_owner_inactive, api_key_owner_not_admin). |
| 403 | Not allowed (insufficient_scope: the API key does not have the required scope, named in `requiredScope`; forbidden: the owner of the key lacks the permission the operation requires). `insufficient_scope` is answered before the request counts against the rate limit, so it carries no `RateLimit-*` headers; `forbidden` does. |
| 404 | Resource not found (not_found): it does not exist or is outside the scope of the API key. |
| 429 | Rate limit exceeded (rate_limited): retry after `Retry-After` seconds; `RateLimit-*` says which quota ran out. |
| 500 | Internal error (internal_error). |

**200**

| Name | Type | Description |
| --- | --- | --- |
| `data` | object | The project in full, as returned by the API. |
| `data.id` | string | Unique project identifier. |
| `data.projectNumber` | string | Human-readable project number; null if not numbered. |
| `data.name` | string | Project name. |
| `data.color` | string | Color associated with the project (for the UI); null if none. |
| `data.externalReference` | string | External reference of the project (for example, from the customer system); null if not recorded. |
| `data.projectTypeId` | string | Project type identifier; null if the project has no type. |
| `data.projectType` | object | Compact reference to the project type; null if none. |
| `data.projectType.id` | string | Unique project type identifier. |
| `data.projectType.name` | string | Project type name. |
| `data.projectType.color` | string | Color associated with the project type (for the UI); null if none. |
| `data.contact` | object | Compact reference to the project contact; null if none. |
| `data.contact.id` | string | Unique contact identifier. |
| `data.contact.name` | string | Contact name. |
| `data.location` | object | Project location; its inner fields are null when not recorded. |
| `data.location.name` | string | Name of the place/location; null if not recorded. |
| `data.location.address` | string | Address of the location; null if not recorded. |
| `data.location.city` | string | City of the location; null if not recorded. |
| `data.location.postalCode` | string | Postal code of the location; null if not recorded. |
| `data.location.province` | string | Province or region of the location; null if not recorded. |
| `data.location.country` | string | Country of the location; null if not recorded. |
| `data.location.lat` | number | Latitude of the location; null if not recorded. |
| `data.location.lng` | number | Longitude of the location; null if not recorded. |
| `data.startDate` | string<date-time> | Project start date in ISO 8601 with offset. |
| `data.endDate` | string<date-time> | Project end date in ISO 8601 with offset. |
| `data.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` |
| `data.archived` | boolean | Whether the project is archived. |
| `data.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=. |
| `data.totalOrders` | integer | Total number of orders in the project (equals orderIds.length). |
| `data.tags` | object[] | Tags attached to the project, with their identifier and name. |
| `data.tags.id` | string | Unique identifier of the tag. |
| `data.tags.name` | string | Tag name. |
| `data.customFields` | object<string, any> | Custom field values by custom field identifier; the definitions are in `/api/v1/custom-fields`. |
| `data.source` | string | Source the project was created from; null if not recorded. |
| `data.createdAt` | string<date-time> | Creation date in ISO 8601 with offset. |
| `data.updatedAt` | string<date-time> | Last update date in ISO 8601 with offset. |
| `meta` | object | Additional information about the response. |
| `meta.warnings` | object[] | Lifecycle warnings; present only when the operation is deprecated. |
| `meta.warnings.code` | string | Stable warning code. `deprecated` |
| `meta.warnings.message` | string | For people: what is deprecated, until when, and what to use. |
| `meta.warnings.sunset` | string | Day (YYYY-MM-DD) the operation stops being served. |
| `meta.warnings.replacement` | string | `operationId` of the operation to use instead, or null if there is none. |
| `meta.warnings.link` | string | Where the deprecation is documented (the changelog). |

*Example response · 200*

```json
{
  "data": {
    "id": "project_9f3a2b",
    "projectNumber": "2026-0001",
    "name": "Example project",
    "color": "Example color",
    "externalReference": "2026-0001",
    "projectTypeId": "project_type_9f3a2b",
    "projectType": {
      "id": "project_type_9f3a2b",
      "name": "Example project type",
      "color": "Example color"
    },
    "contact": {
      "id": "contact_9f3a2b",
      "name": "Example contact"
    },
    "location": {
      "name": "Example location",
      "address": "Example address",
      "city": "Madrid",
      "postalCode": "28001",
      "province": "Madrid",
      "country": "ES",
      "lat": 1,
      "lng": 1
    },
    "startDate": "2026-09-01T08:00:00.000Z",
    "endDate": "2026-09-01T08:00:00.000Z",
    "status": "draft",
    "archived": true,
    "orderIds": [
      "order_9f3a2b"
    ],
    "totalOrders": 1,
    "tags": [
      {
        "id": "tag_9f3a2b",
        "name": "Example tag"
      }
    ],
    "customFields": {
      "example": "example"
    },
    "source": "Example source",
    "createdAt": "2026-09-01T08:00:00.000Z",
    "updatedAt": "2026-09-01T08:00:00.000Z"
  }
}
```

304: No body.

## Errors

| Status | Codes | Meaning |
| --- | --- | --- |
| 404 | `not_found` | It does not exist or is outside the scope of the API key. |

## Deprecation

This operation is not deprecated. Deprecations are announced with a Deprecation header and a sunset date.

---

Canonical URL: https://docs.filmo.io/rest-api/endpoint-reference/projects/get-a-project  
Last updated: 2026-10-25