Proyectos
Obtener un proyecto
Devuelve el detalle de un proyecto por su identificador.
Ejemplos de petición
curl https://app.filmo.io/api/v1/projects/proj_8f2a1c \
--header "Authorization: Bearer $FILMO_API_KEY"Generado a partir del esquema
Autorizaciones
Clave de API como Bearer, con el permiso de abajo. projects:read
Cabeceras
Lectura condicional: el ETag de la copia que ya tienes. Si el recurso no ha cambiado, la respuesta es 304 sin cuerpo.
Ejemplo:"\"3sT3d9pBvZq4h2N0w8x1YkLmQ7c\""
Parámetros de ruta
Identificador del proyecto.
Límites: longitud mín. 1
Respuesta
Respuesta correcta.
Esquema de la respuesta: ProjectDetailDto
Sobre: ProjectDetailResponse. meta. solo aparece cuando la operación está obsoleta.
Cabeceras: X-Request-Id · RateLimit-Limit · RateLimit-Remaining · RateLimit-Reset · ETag
El proyecto completo, tal como lo devuelve la API.
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.
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).
No modificado: el If-None-Match enviado coincide con el ETag actual. Sin cuerpo; la copia que tienes está al día.
Cabeceras: ETag
Sin cuerpo.
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
Recurso no encontrado (not_found): no existe o está fuera del alcance de la clave de API.
Cabeceras: X-Request-Id · Content-Language · RateLimit-Limit · RateLimit-Remaining · RateLimit-Reset
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
Obsolescencia
Esta operación no está obsoleta. Las obsolescencias se anuncian con la cabecera Deprecation y una fecha de retirada. Política de versiones
Relacionado
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?