Proyectos

Obtener un proyecto

Devuelve el detalle de un proyecto por su identificador.

GET
/api/v1/projects/{projectId}

Ejemplos de petición

curl https://app.filmo.io/api/v1/projects/proj_8f2a1c \
  --header "Authorization: Bearer $FILMO_API_KEY"
{
  "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"
  }
}

Generado a partir del esquema

Autorizaciones

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

Cabeceras

If-None-Matchstring

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

projectIdstringObligatorio

Identificador del proyecto.

Límites: longitud mín. 1

Respuesta

application/json

Respuesta correcta.

Esquema de la respuesta: ProjectDetailDto

Sobre: ProjectDetailResponse. meta.warnings solo aparece cuando la operación está obsoleta.

Cabeceras: X-Request-Id · RateLimit-Limit · RateLimit-Remaining · RateLimit-Reset · ETag

dataobject

El proyecto completo, tal como lo devuelve la API.

Mostrar atributos hijos
data.idstring

Identificador único del proyecto.

data.projectNumberstring | null

Número de proyecto legible; null si no está numerado.

data.namestring

Nombre del proyecto.

data.colorstring | null

Color asociado al proyecto (para la interfaz); null si no tiene.

data.externalReferencestring | null

Referencia externa del proyecto (por ejemplo, del sistema del cliente); null si no consta.

data.projectTypeIdstring | null

Identificador del tipo de proyecto; null si el proyecto no tiene tipo.

data.projectTypeobject | null

Referencia compacta al tipo de proyecto; null si no hay.

Mostrar atributos hijos
data.projectType.idstring

Identificador único del tipo de proyecto.

data.projectType.namestring

Nombre del tipo de proyecto.

data.projectType.colorstring | null

Color asociado al tipo de proyecto (para la interfaz); null si no tiene.

data.contactobject | null

Referencia compacta al contacto del proyecto; null si no hay.

Mostrar atributos hijos
data.contact.idstring

Identificador único del contacto.

data.contact.namestring

Nombre del contacto.

data.locationobject

Ubicación del proyecto; sus campos internos son null cuando no se han registrado.

Mostrar atributos hijos
data.location.namestring | null

Nombre del lugar o ubicación; null si no está registrado.

data.location.addressstring | null

Dirección de la ubicación; null si no consta.

data.location.citystring | null

Ciudad de la ubicación; null si no consta.

data.location.postalCodestring | null

Código postal de la ubicación; null si no se ha registrado.

data.location.provincestring | null

Provincia o región de la ubicación; null si no se ha registrado.

data.location.countrystring | null

País de la ubicación; null si no consta.

data.location.latnumber | null

Latitud de la ubicación; null si no está registrada.

data.location.lngnumber | null

Longitud de la ubicación; null si no está registrada.

data.startDatestring<date-time>

Fecha de inicio del proyecto en ISO 8601 con desplazamiento.

data.endDatestring<date-time>

Fecha de fin del proyecto en ISO 8601 con desplazamiento.

data.statusstring

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

data.archivedboolean

Si el proyecto está archivado.

data.orderIdsstring[]

Identificadores de los pedidos del proyecto. El detalle de los pedidos se obtiene en GET /api/v1/orders?projectId=.

data.totalOrdersinteger

Número total de pedidos del proyecto (igual a orderIds.length).

data.tagsobject[]

Etiquetas adjuntas al proyecto, con su identificador y nombre.

Mostrar atributos hijos
data.tags.idstring

Identificador único de la etiqueta.

data.tags.namestring

Nombre de la etiqueta.

data.customFieldsobject<string, any>

Valores de los campos personalizados por identificador de campo personalizado; las definiciones están en /api/v1/custom-fields.

data.sourcestring | null

Origen desde el que se creó el proyecto; null si no consta.

data.createdAtstring<date-time>

Fecha de creación en ISO 8601 con desplazamiento.

data.updatedAtstring<date-time>

Fecha de la última actualización en ISO 8601 con desplazamiento.

metaobject

Información adicional sobre la respuesta.

Mostrar atributos hijos
meta.warningsobject[]

Avisos del ciclo de vida; solo aparecen cuando la operación está obsoleta.

Mostrar atributos hijos
meta.warnings.codestring

Código de aviso estable.

Opciones disponibles: deprecated

meta.warnings.messagestring

Para personas: qué está obsoleto, hasta cuándo y qué usar.

meta.warnings.sunsetstring

Día (YYYY-MM-DD) en que la operación deja de estar disponible.

meta.warnings.replacementstring | null

operationId de la operación que hay que usar en su lugar, o null si no hay ninguna.

Errores

EstadoCódigosSignificado
404not_foundNo existe o queda fuera del alcance de la clave de API.

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

  • Alquileres

    Proyecto

    El proyecto, tal como lo devuelve la API.