Availability

List the unavailabilities of a resource

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

Tool

filmo_unavailabilities_list

Readavailability:read

availability:read
120/min
Server annotation: Read-only
Server annotation: Idempotent

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "filmo_unavailabilities_list",
    "arguments": {
      "resourceType": "staff",
      "limit": 20
    }
  }
}

{
  "structuredContent": {
    "data": [
      {
        "id": "id_8f2a1c",
        "resourceType": "<resourceType>",
        "resourceId": "reso_8f2a1c",
        "resourceName": "Example",
        "startDate": "2026-09-01T08:00:00Z",
        "endDate": "2026-09-01T08:00:00Z",
        "state": "<state>",
        "absenceType": "<absenceType>",
        "updatedAt": "2026-09-01T08:00:00Z"
      }
    ],
    "pagination": {
      "nextCursor": "eyJvIjo1MH0",
      "hasMore": true,
      "total": 1
    },
    "meta": {
      "rateLimit": {
        "limit": 120,
        "remaining": 119,
        "reset": 42
      }
    }
  }
}

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.

Arguments

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

Result

On success the result carries structuredContent with data and meta. These are the attributes of data.

Show the attributes of data

idstring

Unique identifier of the unavailability.

resourceTypestring

Which resource: staff, vehicle or space.

resourceIdstring

Identifier of that resource.

resourceNamestring | null

Resource name; null if not recorded.

startDatestring<date-time>

Start of the unavailability in ISO 8601 UTC.

endDatestring<date-time>

End of the unavailability in ISO 8601 UTC.

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.

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.

updatedAtstring<date-time> | null

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

An error is a result with isError: true and the problem in content[0].text; there is no structuredContent. See Errors.

The same operation by REST

This tool runs GET /api/v1/availability/unavailabilities.

Availability
List the unavailabilities of a resource
Returns the windows in which a person, a vehicle or a space is NOT available.
Guides
Safe writes
An assistant that can write can also write the wrong thing. Decide which tools need a person, retry without duplicating, and know what a write sets in motion.
Guides
Errors
A tool error is a result with isError: true and the problem in the first text block. Branch on its code.

Was this page helpful?

Result

Arguments

Result

The same operation by REST

Related pages

List the unavailabilities of a resource

Safe writes

Errors