List availability block rows
Gateway module
GET/availability-blocksavailabilityBlocks.list
A block of availability or unavailability. Returns a cursor page of availability block rows the caller may see. The default order is `created_at` ascending. Supports sparse fieldsets and the filter grammar.
- Requires the capability me.profile.write.
- OAuth scopes: me.
- Cursor-paginated: limit, cursor, fields, sort and filter apply.
- Error statuses: 400, 401, 429. Errors are RFC 9457 problem details.
Path and query parameters
| Field | Type | Required | Description |
|---|---|---|---|
| limit | Limit | No | Page size. Default 50, maximum 200.Constraints: range 1 to 200 |
| cursor | Cursor | No | Opaque cursor from `next_cursor` of the previous page.Constraints: length 1 to any |
| fields | Fields | No | Sparse fieldset: a comma-separated list of top-level fields to return. `id` is always returned.Constraints: pattern ^[a-z_][a-z0-9_]*(,[a-z_][a-z0-9_]*)*$ |
| sort | Sort | No | Sort keys, comma-separated; a leading `-` sorts descending. Without `sort`, the documented default order applies (coded lists sort in numeric code order).Constraints: pattern ^-?[a-z_][a-z0-9_]*(,-?[a-z_][a-z0-9_]*)*$ |
| filter | Filter | No | Filter grammar `filter[field][op]=value`. Operators: eq, ne, lt, lte, gt, gte, in (comma-separated values), is_null (true or false) and contains. Conditions combine with AND. |
Response 200: a page of AvailabilityBlock
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the availability block. |
| created_at | string (date-time) | Yes | When the row was created. |
| updated_at | string (date-time) | Yes | When the row was last updated. |
| availability_calendar_id | string (uuid) | Yes | Identifier of the availability calendar. |
| starts_at | string (date-time) | Yes | Block start. |
| ends_at | string (date-time) | Yes | Block end. |
| availability_kind | "Available" | "Unavailable" | "Tentative" | Yes | Kind of block. |
| note | string | null | Yes | Private note of the owner.Constraints: length 1 to 2000 |
{
"data": [
{
"id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"created_at": "2026-10-08T14:30:00Z",
"updated_at": "2026-10-08T14:30:00Z",
"availability_calendar_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"starts_at": "2026-10-08T14:30:00Z",
"ends_at": "2026-10-08T14:30:00Z",
"availability_kind": "Available",
"note": "Holding for a tour."
}
],
"next_cursor": null
}Code samples
curl -X GET "$XOS_BASE_URL/availability-blocks" \
-H "Authorization: Bearer $XOS_API_KEY"for await (const row of xos.availabilityBlocks.listAll()) {
console.log(row);
}for row in xos.availability_blocks.list_all():
print(row)xos availability-blocks list --all