*API REST › Referencia de endpoints › Alquileres › Pedidos* # Listar pedidos > Devuelve los pedidos de alquiler, paginados por cursor. El filtro `status` usa grupos operativos de alto nivel. El listado se limita estrictamente a la suscripción de la clave. `GET /api/v1/orders` — permiso `orders:read` Permiso: `orders:read` · 120/min · MCP: `filmo_orders_list` ## Autorizaciones Clave de API como Bearer, con el permiso de abajo. `orders: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 número de pedido, el nombre o alias del proyecto 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, startDate, endDate, orderNumber, grossPrice, rentalDays, itemsCount. 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 grupo de estado operativo (vista de la UI): draft, reserved, prepared (incluye la preparación parcial), in_use (recogido/en uso), returned (incluye la devolución/check-in parcial), completed (con check-in hecho y completado) o cancelled. `draft`, `reserved`, `prepared`, `in_use`, `returned`, `completed`, `cancelled` | | `statuses` | string[] | No | Filtra por status, 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. `draft`, `reserved`, `prepared`, `in_use`, `returned`, `completed`, `cancelled` | | `contactId` | string | No | Filtra por identificador del contacto del pedido. | | `contactIds` | string[] | No | Filtra por contactId, 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. | | `projectId` | string | No | Filtra por identificador del proyecto al que pertenece el pedido. | | `projectIds` | string[] | No | Filtra por projectId, 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. | | `overlapsFrom` | string | No | Inicio de la ventana de solapamiento (ISO 8601 con desplazamiento): devuelve los pedidos cuyo periodo de alquiler se solapa con [overlapsFrom, overlapsTo]. | | `overlapsTo` | string | No | Fin de la ventana de solapamiento (ISO 8601 con desplazamiento): devuelve los pedidos cuyo periodo de alquiler se solapa con [overlapsFrom, overlapsTo]. | | `orderNumber` | string | No | Filtra por número de pedido: coincidencia exacta o por prefijo. | | `orderNumberIs` | string | No | Número de pedido que coincide exactamente. | | `orderNumberContains` | string | No | Número de pedido que contiene este texto en cualquier posición. | | `startsOn` | string | No | La fecha de inicio del pedido 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. | | `startsAfter` | string | No | La fecha de inicio del pedido 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. | | `startsBefore` | string | No | La fecha de inicio del pedido 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. | | `startsFrom` | string | No | La fecha de inicio del pedido 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. | | `startsTo` | string | No | La fecha de inicio del pedido 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. | | `endsOn` | string | No | La fecha de fin del pedido 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. | | `endsAfter` | string | No | La fecha de fin del pedido 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. | | `endsBefore` | string | No | La fecha de fin del pedido 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. | | `endsFrom` | string | No | La fecha de fin del pedido 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. | | `endsTo` | string | No | La fecha de fin del pedido 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. | | `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 pedidos* **cURL** ```bash curl https://app.filmo.io/api/v1/orders \ --header "Authorization: Bearer $FILMO_API_KEY" ``` **Node.js** ```javascript fetch('https://app.filmo.io/api/v1/orders', { headers: { Authorization: 'Bearer YOUR_FILMO_API_KEY' } }) ``` **Python** ```python import requests requests.get("https://app.filmo.io/api/v1/orders", headers={ "Authorization": "Bearer YOUR_FILMO_API_KEY" } ) ``` ## Respuesta Esquema de la respuesta: `OrderDto` | 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 pedido. | | `data.orderNumber` | string | Número de pedido legible. | | `data.externalReference` | string | Referencia externa del pedido (por ejemplo, del sistema del cliente); null si no consta. | | `data.status` | string | Estado bruto del pedido tal como se almacena en la base de datos (12 valores): draft, reserved, prepared_partially, prepared, picked_up_partially, picked_up, returned_partially, returned, checked_in_partially, checked_in, archived o cancelled. `archived` forma parte del conjunto almacenado, pero un pedido archivado no es visible para la API, así que no lo observarás. `draft`, `reserved`, `prepared_partially`, `prepared`, `picked_up_partially`, `picked_up`, `returned_partially`, `returned`, `checked_in_partially`, `checked_in`, `archived`, `cancelled` | | `data.startDate` | string | Inicio del periodo de alquiler en ISO 8601 con desplazamiento. | | `data.endDate` | string | Fin del periodo de alquiler en ISO 8601 con desplazamiento. | | `data.rentalDays` | number | Número de días de alquiler facturables; null si no se ha calculado. | | `data.projectId` | string | Identificador del proyecto al que pertenece el pedido; null si no está vinculado. | | `data.projectName` | string | Nombre del proyecto al que pertenece el pedido; null si no está vinculado. | | `data.contact` | object | Referencia compacta al contacto del pedido; null si no hay. | | `data.contact.id` | string | Identificador único del contacto. | | `data.contact.name` | string | Nombre del contacto. | | `data.itemsCount` | integer | Número de artículos del pedido. | | `data.subTotalPrice` | string | Subtotal antes de descuentos e impuestos, como cadena decimal "1234.50" (ROUND_HALF_UP). | | `data.discountTotal` | string | Total de descuentos como cadena decimal "1234.50" (ROUND_HALF_UP); null si no hay descuento. | | `data.insuranceTotal` | string | Total del seguro como cadena decimal "1234.50" (ROUND_HALF_UP). | | `data.depositTotal` | string | Total de fianzas como cadena decimal "1234.50" (ROUND_HALF_UP). | | `data.taxesPrice` | string | Total de impuestos como cadena decimal "1234.50" (ROUND_HALF_UP). | | `data.netPrice` | string | Base imponible (neto antes de impuestos) como cadena decimal "1234.50" (ROUND_HALF_UP). | | `data.grossPrice` | string | Total con impuestos, como cadena decimal "1234.50" (ROUND_HALF_UP). | | `data.tags` | object[] | Etiquetas adjuntas al pedido, 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 | 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 pedido (por ejemplo web, mobile, admin); null si no consta. | | `data.createdAt` | string | Fecha de creación en ISO 8601 con desplazamiento. | | `data.updatedAt` | string | 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": "order_9f3a2b", "orderNumber": "2026-0001", "externalReference": "2026-0001", "status": "draft", "startDate": "2026-09-01T08:00:00.000Z", "endDate": "2026-09-01T08:00:00.000Z", "rentalDays": 1, "projectId": "project_9f3a2b", "projectName": "Example project name", "contact": { "id": "contact_9f3a2b", "name": "Example contact" }, "itemsCount": 1, "subTotalPrice": "120.00", "discountTotal": "120.00", "insuranceTotal": "120.00", "depositTotal": "120.00", "taxesPrice": "120.00", "netPrice": "120.00", "grossPrice": "120.00", "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/orders/list-orders Última actualización: 2026-10-25