*API REST › Referencia de endpoints › Catálogo e inventario › Colecciones*

# Listar colecciones

> Devuelve el árbol por el que se organiza el catálogo como una lista PLANA: cada nodo con su `parentId`, su `path` completa y su `depth`, de modo que el árbol se reconstruye en una sola pasada.

Filtra por lo que agrupan las colecciones (`entityType`) o por colección padre. Ordenadas por path.

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

Permiso: `collections:read` · 120/min · MCP: `filmo_collections_list`

## Autorizaciones

Clave de API como Bearer, con el permiso de abajo. `collections: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. |
| `sort` | string | No | Orden: hasta 3 campos separados por comas, cada uno con un "-" inicial para descendente (p. ej. "-updatedAt,name"). Campos ordenables: path, name, order, depth, itemCount, createdAt, updatedAt. Por defecto, "path". 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ó. |
| `entityType` | string | No | Filtra por lo que agrupan las colecciones: item, space, vehicle, staff o service. `item`, `space`, `vehicle`, `staff`, `service` |
| `entityTypes` | string[] | No | Filtra por entityType, como lista: repite el parámetro o separa los valores con comas. Acepta hasta 50 valores y devuelve lo que coincida con cualquiera de ellos. `item`, `space`, `vehicle`, `staff`, `service` |
| `parentId` | string | No | Filtra por colección padre: solo se devuelven sus hijas directas. |
| `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 colecciones*

**cURL**

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

**Node.js**

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

**Python**

```python
import requests

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

## Respuesta

Esquema de la respuesta: `CollectionDto`

| 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 de la colección. |
| `data.name` | string | Nombre de la colección. |
| `data.path` | string | Nombre completo desde la colección de nivel superior, con los niveles unidos por " > ". |
| `data.entityType` | string | Qué agrupa la colección: item, space, vehicle, staff o service. `item`, `space`, `vehicle`, `staff`, `service` |
| `data.parentId` | string | Identificador de la colección padre; null para una colección de primer nivel. |
| `data.depth` | integer | Niveles por encima: 0 para una colección de primer nivel, 1 para sus hijas, y así sucesivamente. |
| `data.order` | number | Orden de visualización entre sus hermanos. |
| `data.itemCount` | integer | Entidades directamente en esta colección, sin contar sus subcolecciones. |
| `data.createdAt` | string<date-time> | Fecha de creación en ISO 8601 UTC; null si no consta. |
| `data.updatedAt` | string<date-time> | Fecha de la última modificación en ISO 8601 UTC; null si no está registrada. |
| `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": "collection_9f3a2b",
      "name": "Example collection",
      "path": "Example path",
      "entityType": "item",
      "parentId": "parent_9f3a2b",
      "depth": 1,
      "order": 1,
      "itemCount": 1,
      "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/collections/list-collections  
Última actualización: 2026-10-25