Get/List Availabilities
Retrieve a specific availability or list availabilities with filtering and pagination.
πΉ Endpointsβ
GET /api/v2/availabilities/{id}
GET /api/v2/availabilities
π Authenticationβ
| Header | Required | Description |
|---|---|---|
| Authorization | Yes | Format: ONLIVESITE Credential:ONLIVEAccessKeyId, Signature=CalculatedSignature |
π Path Parameterβ
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | Yes | Availability ID (UUID) |
π Query Parametersβ
| Parameter | Type | Required | Description |
|---|---|---|---|
page | number | No | Page number for pagination |
limit | number | No | Items per page |
calendarId | string (UUID) | No | Filter by calendar ID |
serviceId | string (UUID) | No | Filter by service ID |
Note: Advanced nested calendar filter and relation includes are supported by the backend, but typical usage focuses on calendarId/serviceId with pagination.
π§© Examplesβ
Get by IDβ
curl -X GET "https://openapi.onlive.site/api/v2/availabilities/1610c525-f19a-40d0-8cd1-03daba3d2d98" \
-H "Content-Type: application/json" \
-H "Authorization: ONLIVESITE Credential:ONLIVEAccessKeyId, Signature=CalculatedSignature"
List with Filtersβ
curl -X GET "https://openapi.onlive.site/api/v2/availabilities?page=1&limit=10&calendarId=550e8400-e29b-41d4-a716-446655440000" \
-H "Content-Type: application/json" \
-H "Authorization: ONLIVESITE Credential:ONLIVEAccessKeyId, Signature=CalculatedSignature"
π€ Responsesβ
- 200 OK (single): Returns an
Availabilityobject. - 200 OK (list): Returns a paginated response
{ items, total, page, limit, pages }ofAvailability.
See Availability Properties for the object schema.