*REST API › Endpoint reference › Catalog & inventory › Availability*

# List the unavailabilities of a resource

> Returns the windows in which a person, a vehicle or a space is NOT available.

`absenceType` is emitted for vehicles and spaces, where it is operational, and NOT for people, where it would be health data. The reason for the unavailability is never emitted. Only declarations with `state: unavailable` that have not ended yet (current or future) are returned: an unavailability disappears from the list once its end date has passed, and `available` or `unknown` windows are never listed.

`GET /api/v1/availability/unavailabilities` — scope `availability:read`

Scope: `availability:read` · 120/min · MCP: `filmo_unavailabilities_list`

## Authorizations

Bearer API key with the scope below. `availability:read`

## Query parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `resourceType` | string | Yes | Which resources to query. `staff`, `vehicle`, `space` |
| `resourceId` | string | No | Limit to a specific resource. |
| `startDate` | string<date-time> | No | Start of the window, in ISO 8601 with offset. |
| `endDate` | string<date-time> | No | End of the window, in ISO 8601 with offset. |
| `limit` | integer | No | Page size (1-500). Defaults to 50. = `50` |
| `cursor` | string | No | Opaque cursor of the page to return. Pass the value of `pagination.nextCursor` from the previous response; treat it as opaque. |

## Request examples

*List the unavailabilities of a resource*

**cURL**

```bash
curl 'https://app.filmo.io/api/v1/availability/unavailabilities?resourceType=staff' \
  --header "Authorization: Bearer $FILMO_API_KEY"
```

**Node.js**

```javascript
fetch('https://app.filmo.io/api/v1/availability/unavailabilities?resourceType=staff', {
  headers: {
    Authorization: 'Bearer YOUR_FILMO_API_KEY'
  }
})
```

**Python**

```python
import requests

requests.get(
    "https://app.filmo.io/api/v1/availability/unavailabilities?resourceType=staff",
    headers={
      "Authorization": "Bearer YOUR_FILMO_API_KEY"
    }
)
```

## Response

Response schema: `UnavailabilityDto`

| Status | Description |
| --- | --- |
| 200 | Successful response. |
| 400 | Invalid request (validation_error): malformed query or body. `errors[]` lists every offending field with its stable code. |
| 401 | Authentication failed (unauthorized, api_key_invalid, api_key_revoked, api_key_expired, api_key_owner_inactive, api_key_owner_not_admin). |
| 403 | Not allowed (insufficient_scope: the API key does not have the required scope, named in `requiredScope`; forbidden: the owner of the key lacks the permission the operation requires). `insufficient_scope` is answered before the request counts against the rate limit, so it carries no `RateLimit-*` headers; `forbidden` does. |
| 429 | Rate limit exceeded (rate_limited): retry after `Retry-After` seconds; `RateLimit-*` says which quota ran out. |
| 500 | Internal error (internal_error). |

**200**

| Name | Type | Description |
| --- | --- | --- |
| `data` | object[] |  |
| `data.id` | string | Unique identifier of the unavailability. |
| `data.resourceType` | string | Which resource: staff, vehicle or space. |
| `data.resourceId` | string | Identifier of that resource. |
| `data.resourceName` | string | Resource name; null if not recorded. |
| `data.startDate` | string<date-time> | Start of the unavailability in ISO 8601 UTC. |
| `data.endDate` | string<date-time> | End of the unavailability in ISO 8601 UTC. |
| `data.state` | string | Declared state. This list only returns `unavailable` windows that have not ended yet, so it is always `unavailable` here; `available` and `unknown` exist as declarations but are not listed. |
| `data.absenceType` | string | Absence type. Only emitted for vehicles and spaces, where it is operational; for staff it is health data and is returned as null. |
| `data.updatedAt` | string<date-time> | Last modification in ISO 8601 UTC; null if not recorded. |
| `pagination` | object | Opaque-cursor pagination metadata. |
| `pagination.nextCursor` | string | Opaque cursor of the next page; null when there are no more results. Pass it as `cursor` in the next request. |
| `pagination.hasMore` | boolean | Whether more results exist beyond this page. |
| `pagination.total` | integer | Number of results matching the filters across all pages. Present only when the request sets `includeTotal=true`. |
| `meta` | object | Additional information about the response. |
| `meta.warnings` | object[] | Lifecycle warnings; present only when the operation is deprecated. |
| `meta.warnings.code` | string | Stable warning code. `deprecated` |
| `meta.warnings.message` | string | For people: what is deprecated, until when, and what to use. |
| `meta.warnings.sunset` | string | Day (YYYY-MM-DD) the operation stops being served. |
| `meta.warnings.replacement` | string | `operationId` of the operation to use instead, or null if there is none. |
| `meta.warnings.link` | string | Where the deprecation is documented (the changelog). |

*Example response · 200*

```json
{
  "data": [
    {
      "id": "unavailability_9f3a2b",
      "resourceType": "Example resource type",
      "resourceId": "resource_9f3a2b",
      "resourceName": "Example resource name",
      "startDate": "2026-09-01T08:00:00.000Z",
      "endDate": "2026-09-01T08:00:00.000Z",
      "state": "Madrid",
      "absenceType": "Example absence type",
      "updatedAt": "2026-09-01T08:00:00.000Z"
    }
  ],
  "pagination": {
    "nextCursor": "eyJvIjoyMH0",
    "hasMore": true,
    "total": 1
  }
}
```

## Errors

| Status | Codes | Meaning |
| --- | --- | --- |
| 400 | `validation_error` | Malformed query or body. `errors[]` lists every offending field with its stable code. |

## Deprecation

This operation is not deprecated. Deprecations are announced with a Deprecation header and a sunset date.

---

Canonical URL: https://docs.filmo.io/rest-api/endpoint-reference/availability/list-the-unavailabilities-of-a-resource  
Last updated: 2026-10-25