*API REST › Referencia de endpoints › Alquileres › Proyectos*

# Obtener un proyecto

> Devuelve el detalle de un proyecto por su identificador.

`GET /api/v1/projects/{projectId}` — permiso `projects:read`

Permiso: `projects:read` · 120/min · Ámbito heredado · If-None-Match · MCP: `filmo_projects_get`

## Autorizaciones

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

## Cabeceras

| Nombre | Tipo | Obligatorio | Descripción |
| --- | --- | --- | --- |
| `If-None-Match` | string | No | Lectura condicional: el `ETag` de la copia que ya tienes. Si el recurso no ha cambiado, la respuesta es `304` sin cuerpo. |

## Parámetros de ruta

| Nombre | Tipo | Obligatorio | Descripción |
| --- | --- | --- | --- |
| `projectId` | string | Sí | Identificador del proyecto. |

## Ejemplos de petición

*Obtener un proyecto*

**cURL**

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

**Node.js**

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

**Python**

```python
import requests

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

## Respuesta

Esquema de la respuesta: `ProjectDetailDto`

| Estado | Descripción |
| --- | --- |
| 200 | Respuesta correcta. |
| 304 | No modificado: el `If-None-Match` enviado coincide con el `ETag` actual. Sin cuerpo; la copia que tienes está al día. |
| 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í. |
| 404 | Recurso no encontrado (not_found): no existe o está fuera del alcance de la clave de API. |
| 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 | El proyecto completo, tal como lo devuelve la API. |
| `data.id` | string | Identificador único del proyecto. |
| `data.projectNumber` | string | Número de proyecto legible; null si no está numerado. |
| `data.name` | string | Nombre del proyecto. |
| `data.color` | string | Color asociado al proyecto (para la interfaz); null si no tiene. |
| `data.externalReference` | string | Referencia externa del proyecto (por ejemplo, del sistema del cliente); null si no consta. |
| `data.projectTypeId` | string | Identificador del tipo de proyecto; null si el proyecto no tiene tipo. |
| `data.projectType` | object | Referencia compacta al tipo de proyecto; null si no hay. |
| `data.projectType.id` | string | Identificador único del tipo de proyecto. |
| `data.projectType.name` | string | Nombre del tipo de proyecto. |
| `data.projectType.color` | string | Color asociado al tipo de proyecto (para la interfaz); null si no tiene. |
| `data.contact` | object | Referencia compacta al contacto del proyecto; null si no hay. |
| `data.contact.id` | string | Identificador único del contacto. |
| `data.contact.name` | string | Nombre del contacto. |
| `data.location` | object | Ubicación del proyecto; sus campos internos son null cuando no se han registrado. |
| `data.location.name` | string | Nombre del lugar o ubicación; null si no está registrado. |
| `data.location.address` | string | Dirección de la ubicación; null si no consta. |
| `data.location.city` | string | Ciudad de la ubicación; null si no consta. |
| `data.location.postalCode` | string | Código postal de la ubicación; null si no se ha registrado. |
| `data.location.province` | string | Provincia o región de la ubicación; null si no se ha registrado. |
| `data.location.country` | string | País de la ubicación; null si no consta. |
| `data.location.lat` | number | Latitud de la ubicación; null si no está registrada. |
| `data.location.lng` | number | Longitud de la ubicación; null si no está registrada. |
| `data.startDate` | string<date-time> | Fecha de inicio del proyecto en ISO 8601 con desplazamiento. |
| `data.endDate` | string<date-time> | Fecha de fin del proyecto en ISO 8601 con desplazamiento. |
| `data.status` | string | 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. `draft`, `budgeted`, `confirmed`, `in_progress`, `invoiced`, `completed`, `cancelled`, `archived` |
| `data.archived` | boolean | Si el proyecto está archivado. |
| `data.orderIds` | string[] | Identificadores de los pedidos del proyecto. El detalle de los pedidos se obtiene en [`GET /api/v1/orders`](https://docs.filmo.io/es/rest-api/endpoint-reference/orders/list-orders)?projectId=. |
| `data.totalOrders` | integer | Número total de pedidos del proyecto (igual a orderIds.length). |
| `data.tags` | object[] | Etiquetas adjuntas al proyecto, 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<string, any> | 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 proyecto; null si no consta. |
| `data.createdAt` | string<date-time> | Fecha de creación en ISO 8601 con desplazamiento. |
| `data.updatedAt` | string<date-time> | Fecha de la última actualización en ISO 8601 con desplazamiento. |
| `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": "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"
  }
}
```

304: Sin cuerpo.

## Errores

| Estado | Códigos | Significado |
| --- | --- | --- |
| 404 | `not_found` | No existe o queda fuera del alcance de la clave de API. |

## 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/projects/get-a-project  
Última actualización: 2026-10-25