*API REST › Referencia de endpoints › Alquileres › Proyectos*

# Listar proyectos

> Devuelve los proyectos que agrupan pedidos y trabajo, paginados por cursor.

Aislamiento heredado de la cuenta principal: una cuenta de facturación ve también los proyectos de su cuenta principal.

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

Permiso: `projects:read` · 120/min · Ámbito heredado · MCP: `filmo_projects_list`

## Autorizaciones

Clave de API como Bearer, con el permiso de abajo. `projects:read`

## Parámetros de consulta

| Nombre | Tipo | Obligatorio | Descripción |
| --- | --- | --- | --- |
| `limit` | integer | No | Tamaño de página (1-500). Por defecto es 50. = `50` |
| `cursor` | string | No | Cursor opaco de la página que se devuelve. Pasa el valor de `pagination.nextCursor` de la respuesta anterior; trátalo como opaco. |
| `createdOn` | string | No | La fecha de creación del recurso cae en esta fecha. Una fecha sin hora (YYYY-MM-DD, interpretada en la zona horaria del negocio) o un instante ISO 8601 con desplazamiento. |
| `createdAfter` | string | No | La fecha de creación del recurso es posterior a esta fecha. Una fecha sin hora (YYYY-MM-DD, interpretada en la zona horaria del negocio) o un instante ISO 8601 con desplazamiento. |
| `createdBefore` | string | No | La fecha de creación del recurso es anterior a esta fecha. Una fecha sin hora (YYYY-MM-DD, interpretada en la zona horaria del negocio) o un instante ISO 8601 con desplazamiento. |
| `createdFrom` | string | No | La fecha de creación del recurso es igual o posterior a esta fecha. Una fecha sin hora (YYYY-MM-DD, interpretada en la zona horaria del negocio) o un instante ISO 8601 con desplazamiento. |
| `createdTo` | string | No | La fecha de creación del recurso es igual o anterior a esta fecha. Una fecha sin hora (YYYY-MM-DD, interpretada en la zona horaria del negocio) o un instante ISO 8601 con desplazamiento. |
| `updatedOn` | string | No | La fecha de última actualización del recurso cae en esta fecha. Una fecha sin hora (YYYY-MM-DD, interpretada en la zona horaria del negocio) o un instante ISO 8601 con desplazamiento. |
| `updatedAfter` | string | No | La fecha de última actualización del recurso es posterior a esta fecha. Una fecha sin hora (YYYY-MM-DD, interpretada en la zona horaria del negocio) o un instante ISO 8601 con desplazamiento. |
| `updatedBefore` | string | No | La fecha de última actualización del recurso es anterior a esta fecha. Una fecha sin hora (YYYY-MM-DD, interpretada en la zona horaria del negocio) o un instante ISO 8601 con desplazamiento. |
| `updatedFrom` | string | No | La fecha de última actualización del recurso es igual o posterior a esta fecha. Una fecha sin hora (YYYY-MM-DD, interpretada en la zona horaria del negocio) o un instante ISO 8601 con desplazamiento. |
| `updatedTo` | string | No | La fecha de última actualización del recurso es igual o anterior a esta fecha. Una fecha sin hora (YYYY-MM-DD, interpretada en la zona horaria del negocio) o un instante ISO 8601 con desplazamiento. |
| `q` | string | No | Búsqueda de texto libre en el nombre y la referencia externa. |
| `sort` | string | No | Orden: hasta 3 campos separados por comas, cada uno con un "-" inicial para descendente (p. ej. "-updatedAt,name"). Campos ordenables: createdAt, updatedAt, name, projectNumber, startDate, endDate, status. Por defecto, "-createdAt". Los empates se resuelven por id, así que el orden es estable entre páginas, y un cursor queda ligado al orden con el que se emitió. |
| `status` | string | No | Filtra por estado del proyecto: draft, budgeted, confirmed, in_progress, invoiced, completed, cancelled o archived (estado heredado presente en datos antiguos). `draft`, `budgeted`, `confirmed`, `in_progress`, `invoiced`, `completed`, `cancelled`, `archived` |
| `contactId` | string | No | Filtra por identificador del contacto del proyecto. |
| `projectTypeId` | string | No | Filtra por identificador del tipo de proyecto. |
| `archived` | boolean | No | Filtra por archivado: "true" lista SOLO los proyectos archivados; "false" (o ausente) los excluye del listado. |
| `includeTotal` | boolean | No | Ponlo en true para incluir `pagination.total`, el número de resultados que coinciden con los filtros en todas las páginas. Desactivado por defecto. = `false` |

## Ejemplos de petición

*Listar proyectos*

**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"
    }
)
```

## Respuesta

Esquema de la respuesta: `ProjectDto`

| Estado | Descripción |
| --- | --- |
| 200 | Respuesta correcta. |
| 400 | Petición no válida (validation_error): consulta o cuerpo mal formados. `errors[]` enumera cada campo erróneo con su código estable. |
| 401 | Fallo de autenticación (unauthorized, api_key_invalid, api_key_revoked, api_key_expired, api_key_owner_inactive, api_key_owner_not_admin). |
| 403 | No permitido (insufficient_scope: la clave de API no tiene el scope requerido, indicado en `requiredScope`; forbidden: el propietario de la clave carece del permiso que exige la operación). `insufficient_scope` se responde antes de que la petición cuente contra el límite de peticiones, así que no lleva cabeceras `RateLimit-*`; `forbidden` sí. |
| 429 | Límite de peticiones superado (rate_limited): reintenta tras `Retry-After` segundos; `RateLimit-*` indica qué cuota se ha agotado. |
| 500 | Error interno (internal_error). |

**200**

| Nombre | Tipo | Descripción |
| --- | --- | --- |
| `data` | object[] |  |
| `data.id` | string | Identificador único del proyecto. |
| `data.projectNumber` | string | Número de proyecto legible; null si no está numerado. |
| `data.name` | string | Nombre del proyecto. |
| `data.color` | string | Color asociado al proyecto (para la interfaz); null si no tiene. |
| `data.externalReference` | string | Referencia externa del proyecto (por ejemplo, del sistema del cliente); null si no consta. |
| `data.projectTypeId` | string | Identificador del tipo de proyecto; null si el proyecto no tiene tipo. |
| `data.projectType` | object | Referencia compacta al tipo de proyecto; null si no hay. |
| `data.projectType.id` | string | Identificador único del tipo de proyecto. |
| `data.projectType.name` | string | Nombre del tipo de proyecto. |
| `data.projectType.color` | string | Color asociado al tipo de proyecto (para la interfaz); null si no tiene. |
| `data.contact` | object | Referencia compacta al contacto del proyecto; null si no hay. |
| `data.contact.id` | string | Identificador único del contacto. |
| `data.contact.name` | string | Nombre del contacto. |
| `data.location` | object | Ubicación del proyecto; sus campos internos son null cuando no se han registrado. |
| `data.location.name` | string | Nombre del lugar o ubicación; null si no está registrado. |
| `data.location.address` | string | Dirección de la ubicación; null si no consta. |
| `data.location.city` | string | Ciudad de la ubicación; null si no consta. |
| `data.location.postalCode` | string | Código postal de la ubicación; null si no se ha registrado. |
| `data.location.province` | string | Provincia o región de la ubicación; null si no se ha registrado. |
| `data.location.country` | string | País de la ubicación; null si no consta. |
| `data.location.lat` | number | Latitud de la ubicación; null si no está registrada. |
| `data.location.lng` | number | Longitud de la ubicación; null si no está registrada. |
| `data.startDate` | string<date-time> | Fecha de inicio del proyecto en ISO 8601 con desplazamiento. |
| `data.endDate` | string<date-time> | Fecha de fin del proyecto en ISO 8601 con desplazamiento. |
| `data.status` | string | Estado del proyecto: draft, budgeted, confirmed, in_progress, invoiced, completed, cancelled o archived. `archived` es un estado HEREDADO que aparece en datos antiguos; el estado archivado actual se expresa mediante el booleano `archived` de este mismo DTO. `draft`, `budgeted`, `confirmed`, `in_progress`, `invoiced`, `completed`, `cancelled`, `archived` |
| `data.archived` | boolean | Si el proyecto está archivado. |
| `data.orderIds` | string[] | Identificadores de los pedidos del proyecto. El detalle de los pedidos se obtiene en [`GET /api/v1/orders`](https://docs.filmo.io/es/rest-api/endpoint-reference/orders/list-orders)?projectId=. |
| `data.totalOrders` | integer | Número total de pedidos del proyecto (igual a orderIds.length). |
| `data.tags` | object[] | Etiquetas adjuntas al proyecto, con su identificador y nombre. |
| `data.tags.id` | string | Identificador único de la etiqueta. |
| `data.tags.name` | string | Nombre de la etiqueta. |
| `data.customFields` | object<string, any> | Valores de los campos personalizados por identificador de campo personalizado; las definiciones están en `/api/v1/custom-fields`. |
| `data.source` | string | Origen desde el que se creó el proyecto; null si no consta. |
| `data.createdAt` | string<date-time> | Fecha de creación en ISO 8601 con desplazamiento. |
| `data.updatedAt` | string<date-time> | Fecha de la última actualización en ISO 8601 con desplazamiento. |
| `pagination` | object | Metadatos de paginación por cursor opaco. |
| `pagination.nextCursor` | string | Cursor opaco de la página siguiente; null cuando no hay más resultados. Pásalo como `cursor` en la siguiente petición. |
| `pagination.hasMore` | boolean | Si existen más resultados después de esta página. |
| `pagination.total` | integer | Número de resultados que coinciden con los filtros en todas las páginas. Solo aparece cuando la petición establece `includeTotal=true`. |
| `meta` | object | Información adicional sobre la respuesta. |
| `meta.warnings` | object[] | Avisos del ciclo de vida; solo aparecen cuando la operación está obsoleta. |
| `meta.warnings.code` | string | Código de aviso estable. `deprecated` |
| `meta.warnings.message` | string | Para personas: qué está obsoleto, hasta cuándo y qué usar. |
| `meta.warnings.sunset` | string | Día (YYYY-MM-DD) en que la operación deja de estar disponible. |
| `meta.warnings.replacement` | string | `operationId` de la operación que hay que usar en su lugar, o null si no hay ninguna. |
| `meta.warnings.link` | string | Dónde está documentada la deprecación (el changelog). |

*Respuesta de ejemplo · 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
  }
}
```

## Errores

| Estado | Códigos | Significado |
| --- | --- | --- |
| 400 | `validation_error` | Consulta o cuerpo mal formados. `errors[]` enumera cada campo erróneo con su código estable. |

## Obsolescencia

Esta operación no está obsoleta. Las obsolescencias se anuncian con la cabecera Deprecation y una fecha de retirada.

---

URL canónica: https://docs.filmo.io/es/rest-api/endpoint-reference/projects/list-projects  
Última actualización: 2026-10-25