Availability

List the unavailabilities of a resource

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

GET
/api/v1/availability/unavailabilities

Request examples

curl 'https://app.filmo.io/api/v1/availability/unavailabilities?resourceType=staff' \
  --header "Authorization: Bearer $FILMO_API_KEY"
{
  "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
  }
}

Generated from the schema

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.

Authorizations

Bearer API key with the scope below. availability:read

Query parameters

resourceTypestringRequired

Which resources to query.

Available options: staff, vehicle, space

resourceIdstring

Limit to a specific resource.

Limits: min length 1

startDatestring<date-time>

Start of the window, in ISO 8601 with offset.

endDatestring<date-time>

End of the window, in ISO 8601 with offset.

limitintegerdefault:50

Page size (1-500). Defaults to 50.

Limits: min 1, max 500

cursorstring

Opaque cursor of the page to return. Pass the value of pagination.nextCursor from the previous response; treat it as opaque.

Limits: max length 200

Response

application/json

Successful response.

Response schema: UnavailabilityDto

Envelope: UnavailabilityList. meta.warnings is present only when the operation is deprecated.

Headers: X-Request-Id · RateLimit-Limit · RateLimit-Remaining · RateLimit-Reset

dataobject[]

Show child attributes
data.idstring

Unique identifier of the unavailability.

data.resourceTypestring

Which resource: staff, vehicle or space.

data.resourceIdstring

Identifier of that resource.

data.resourceNamestring | null

Resource name; null if not recorded.

data.startDatestring<date-time>

Start of the unavailability in ISO 8601 UTC.

data.endDatestring<date-time>

End of the unavailability in ISO 8601 UTC.

data.statestring

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.absenceTypestring | null

Absence type. Only emitted for vehicles and spaces, where it is operational; for staff it is health data and is returned as null.

data.updatedAtstring<date-time> | null

Last modification in ISO 8601 UTC; null if not recorded.

paginationobject

Opaque-cursor pagination metadata.

Show child attributes
pagination.nextCursorstring | null

Opaque cursor of the next page; null when there are no more results. Pass it as cursor in the next request.

pagination.hasMoreboolean

Whether more results exist beyond this page.

pagination.totalinteger

Number of results matching the filters across all pages. Present only when the request sets includeTotal=true.

Limits: min 0

metaobject

Additional information about the response.

Show child attributes
meta.warningsobject[]

Lifecycle warnings; present only when the operation is deprecated.

Show child attributes
meta.warnings.codestring

Stable warning code.

Available options: deprecated

meta.warnings.messagestring

For people: what is deprecated, until when, and what to use.

meta.warnings.sunsetstring

Day (YYYY-MM-DD) the operation stops being served.

meta.warnings.replacementstring | null

operationId of the operation to use instead, or null if there is none.

Errors

StatusCodesMeaning
400validation_errorMalformed query or body. errors[] lists every offending field with its stable code.

401, 403, 429, 500 can be returned by any operation. Errors

Deprecation

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

  • Catalog & inventory

    Unavailability

    Window in which a resource is NOT available.