*REST API › Endpoint reference › Rentals › Projects*

# List projects

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

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

`GET /api/v1/projects` — scope `projects:read`

Scope: `projects:read` · 120/min · Inherited tenancy · MCP: `filmo_projects_list`

## Authorizations

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

## Query parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `limit` | integer | No | Page size (1-500). Defaults to 50. = `50` |
| `cursor` | string | No | Opaque cursor of the page to return. Pass the value of `pagination.nextCursor` from the previous response; treat it as opaque. |
| `createdOn` | string | No | The creation date of the resource falls on this date. A bare day (YYYY-MM-DD, read in the business timezone) or an ISO 8601 instant with offset. |
| `createdAfter` | string | No | The creation date of the resource is after this date. A bare day (YYYY-MM-DD, read in the business timezone) or an ISO 8601 instant with offset. |
| `createdBefore` | string | No | The creation date of the resource is before this date. A bare day (YYYY-MM-DD, read in the business timezone) or an ISO 8601 instant with offset. |
| `createdFrom` | string | No | The creation date of the resource is on or after this date. A bare day (YYYY-MM-DD, read in the business timezone) or an ISO 8601 instant with offset. |
| `createdTo` | string | No | The creation date of the resource is on or before this date. A bare day (YYYY-MM-DD, read in the business timezone) or an ISO 8601 instant with offset. |
| `updatedOn` | string | No | The last update date of the resource falls on this date. A bare day (YYYY-MM-DD, read in the business timezone) or an ISO 8601 instant with offset. |
| `updatedAfter` | string | No | The last update date of the resource is after this date. A bare day (YYYY-MM-DD, read in the business timezone) or an ISO 8601 instant with offset. |
| `updatedBefore` | string | No | The last update date of the resource is before this date. A bare day (YYYY-MM-DD, read in the business timezone) or an ISO 8601 instant with offset. |
| `updatedFrom` | string | No | The last update date of the resource is on or after this date. A bare day (YYYY-MM-DD, read in the business timezone) or an ISO 8601 instant with offset. |
| `updatedTo` | string | No | The last update date of the resource is on or before this date. A bare day (YYYY-MM-DD, read in the business timezone) or an ISO 8601 instant with offset. |
| `q` | string | No | Free-text search on the name and the external reference. |
| `sort` | string | No | 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. |
| `status` | string | No | Filter by project status: draft, budgeted, confirmed, in_progress, invoiced, completed, cancelled or archived (legacy status present in old data). `draft`, `budgeted`, `confirmed`, `in_progress`, `invoiced`, `completed`, `cancelled`, `archived` |
| `contactId` | string | No | Filter by project contact identifier. |
| `projectTypeId` | string | No | Filter by project type identifier. |
| `archived` | boolean | No | Filter by archived: "true" lists ONLY archived projects; "false" (or absent) excludes them from the listing. |
| `includeTotal` | boolean | No | Set it to true to include `pagination.total`, the number of results that match the filters across all pages. Off by default. = `false` |

## Request examples

*List projects*

**cURL**

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

**Node.js**

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

**Python**

```python
import requests

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

## Response

Response schema: `ProjectDto`

| Status | Description |
| --- | --- |
| 200 | Successful response. |
| 400 | Invalid request (validation_error): malformed query or body. `errors[]` lists every offending field with its stable code. |
| 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. |
| 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[] |  |
| `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. |
| `pagination` | object | Opaque-cursor pagination metadata. |
| `pagination.nextCursor` | string | Opaque cursor of the next page; null when there are no more results. Pass it as `cursor` in the next request. |
| `pagination.hasMore` | boolean | Whether more results exist beyond this page. |
| `pagination.total` | integer | Number of results matching the filters across all pages. Present only when the request sets `includeTotal=true`. |
| `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"
    }
  ],
  "pagination": {
    "nextCursor": "eyJvIjoyMH0",
    "hasMore": true,
    "total": 1
  }
}
```

## Errors

| Status | Codes | Meaning |
| --- | --- | --- |
| 400 | `validation_error` | Malformed query or body. `errors[]` lists every offending field with its stable code. |

## 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/list-projects  
Last updated: 2026-10-25