Proyectos
Listar proyectos
Devuelve los proyectos que agrupan pedidos y trabajo, paginados por cursor.
Ejemplos de petición
curl https://app.filmo.io/api/v1/projects \
--header "Authorization: Bearer $FILMO_API_KEY"Generado a partir del esquema
Aislamiento heredado de la cuenta principal: una cuenta de facturación ve también los proyectos de su cuenta principal.
Autorizaciones
Clave de API como Bearer, con el permiso de abajo. projects:read
Parámetros de consulta
Tamaño de página (1-500). Por defecto es 50.
Límites: mín. 1, máx. 500
Cursor opaco de la página que se devuelve. Pasa el valor de pagination. de la respuesta anterior; trátalo como opaco.
Límites: longitud máx. 200
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.
Límites: patrón ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+-]\d{2}(:?\d{2})?))?$
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.
Límites: patrón ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+-]\d{2}(:?\d{2})?))?$
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.
Límites: patrón ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+-]\d{2}(:?\d{2})?))?$
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.
Límites: patrón ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+-]\d{2}(:?\d{2})?))?$
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.
Límites: patrón ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+-]\d{2}(:?\d{2})?))?$
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.
Límites: patrón ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+-]\d{2}(:?\d{2})?))?$
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.
Límites: patrón ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+-]\d{2}(:?\d{2})?))?$
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.
Límites: patrón ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+-]\d{2}(:?\d{2})?))?$
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.
Límites: patrón ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+-]\d{2}(:?\d{2})?))?$
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.
Límites: patrón ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+-]\d{2}(:?\d{2})?))?$
Búsqueda de texto libre en el nombre y la referencia externa.
Límites: longitud mín. 1, longitud máx. 200
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ó.
Límites: longitud máx. 200
Filtra por estado del proyecto: draft, budgeted, confirmed, in_progress, invoiced, completed, cancelled o archived (estado heredado presente en datos antiguos).
Opciones disponibles: draft, budgeted, confirmed, in_progress, invoiced, completed, cancelled, archived
Filtra por identificador del contacto del proyecto.
Límites: longitud mín. 1, longitud máx. 100
Filtra por identificador del tipo de proyecto.
Límites: longitud mín. 1, longitud máx. 100
Filtra por archivado: "true" lista SOLO los proyectos archivados; "false" (o ausente) los excluye del listado.
Ponlo en true para incluir pagination., el número de resultados que coinciden con los filtros en todas las páginas. Desactivado por defecto.
Respuesta
Respuesta correcta.
Esquema de la respuesta: ProjectDto
Sobre: ProjectList. meta. solo aparece cuando la operación está obsoleta.
Cabeceras: X-Request-Id · RateLimit-Limit · RateLimit-Remaining · RateLimit-Reset
Mostrar atributos hijosOcultar atributos hijos
Identificador único del proyecto.
Número de proyecto legible; null si no está numerado.
Nombre del proyecto.
Color asociado al proyecto (para la interfaz); null si no tiene.
Referencia externa del proyecto (por ejemplo, del sistema del cliente); null si no consta.
Identificador del tipo de proyecto; null si el proyecto no tiene tipo.
Referencia compacta al tipo de proyecto; null si no hay.
Mostrar atributos hijosOcultar atributos hijos
Identificador único del tipo de proyecto.
Nombre del tipo de proyecto.
Color asociado al tipo de proyecto (para la interfaz); null si no tiene.
Referencia compacta al contacto del proyecto; null si no hay.
Mostrar atributos hijosOcultar atributos hijos
Identificador único del contacto.
Nombre del contacto.
Ubicación del proyecto; sus campos internos son null cuando no se han registrado.
Mostrar atributos hijosOcultar atributos hijos
Nombre del lugar o ubicación; null si no está registrado.
Dirección de la ubicación; null si no consta.
Ciudad de la ubicación; null si no consta.
Código postal de la ubicación; null si no se ha registrado.
Provincia o región de la ubicación; null si no se ha registrado.
País de la ubicación; null si no consta.
Latitud de la ubicación; null si no está registrada.
Longitud de la ubicación; null si no está registrada.
Fecha de inicio del proyecto en ISO 8601 con desplazamiento.
Fecha de fin del proyecto en ISO 8601 con desplazamiento.
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.
Opciones disponibles: draft, budgeted, confirmed, in_progress, invoiced, completed, cancelled, archived
Si el proyecto está archivado.
Identificadores de los pedidos del proyecto. El detalle de los pedidos se obtiene en GET /api?projectId=.
Número total de pedidos del proyecto (igual a orderIds.length).
Valores de los campos personalizados por identificador de campo personalizado; las definiciones están en /api.
Origen desde el que se creó el proyecto; null si no consta.
Fecha de creación en ISO 8601 con desplazamiento.
Fecha de la última actualización en ISO 8601 con desplazamiento.
Metadatos de paginación por cursor opaco.
Mostrar atributos hijosOcultar atributos hijos
Cursor opaco de la página siguiente; null cuando no hay más resultados. Pásalo como cursor en la siguiente petición.
Si existen más resultados después de esta página.
Número de resultados que coinciden con los filtros en todas las páginas. Solo aparece cuando la petición establece includeTotal=true.
Límites: mín. 0
Información adicional sobre la respuesta.
Mostrar atributos hijosOcultar atributos hijos
Avisos del ciclo de vida; solo aparecen cuando la operación está obsoleta.
Mostrar atributos hijosOcultar atributos hijos
Código de aviso estable.
Opciones disponibles: deprecated
Para personas: qué está obsoleto, hasta cuándo y qué usar.
Día (YYYY-MM-DD) en que la operación deja de estar disponible.
operationId de la operación que hay que usar en su lugar, o null si no hay ninguna.
Dónde está documentada la deprecación (el changelog).
Petición no válida (validation_error): consulta o cuerpo mal formados. errors[] enumera cada campo erróneo con su código estable.
Cabeceras: X-Request-Id · Content-Language · RateLimit-Limit · RateLimit-Remaining · RateLimit-Reset
Fallo de autenticación (unauthorized, api_key_invalid, api_key_revoked, api_key_expired, api_key_owner_inactive, api_key_owner_not_admin).
Cabeceras: X-Request-Id · Content-Language
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í.
Cabeceras: X-Request-Id · Content-Language
Límite de peticiones superado (rate_limited): reintenta tras Retry-After segundos; RateLimit-* indica qué cuota se ha agotado.
Cabeceras: X-Request-Id · Content-Language · RateLimit-Limit · RateLimit-Remaining · RateLimit-Reset · Retry-After
Error interno (internal_error).
Cabeceras: X-Request-Id · Content-Language · RateLimit-Limit · RateLimit-Remaining · RateLimit-Reset
Errores
| Estado | Códigos | Significado |
|---|---|---|
| 400 | validation_error | Consulta o cuerpo mal formados. errors[] enumera cada campo erróneo con su código estable. |
401, 403, 429, 500 los puede devolver cualquier operación. Errores
Obsolescencia
Esta operación no está obsoleta. Las obsolescencias se anuncian con la cabecera Deprecation y una fecha de retirada. Política de versiones
Páginas relacionadas
Enlace a esta sección: Páginas relacionadasAlquileres
Proyecto
El proyecto, tal como lo devuelve la API.
¿Te ha resultado útil esta página?