Get an availability block
Gateway module
GET/availability-blocks/{id}availabilityBlocks.get
A block of availability or unavailability. Returns one availability block with its `ETag`. A availability block the caller may not see returns 404.
- Requires the capability me.profile.write.
- OAuth scopes: me.
- Error statuses: 400, 401, 404, 429. Errors are RFC 9457 problem details.
Path and query parameters
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the availability block. |
| 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_]*)*$ |
Response 200: 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 |
{
"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."
}Code samples
curl -X GET "$XOS_BASE_URL/availability-blocks/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
-H "Authorization: Bearer $XOS_API_KEY"const { data, etag } = await xos.availabilityBlocks.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");response = xos.availability_blocks.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")xos availability-blocks get 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f