Skip to main content

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​

HeaderRequiredDescription
AuthorizationYesFormat: ONLIVESITE Credential:ONLIVEAccessKeyId, Signature=CalculatedSignature

πŸ“ Path Parameter​

ParameterTypeRequiredDescription
idstringYesAvailability ID (UUID)

πŸ”Ž Query Parameters​

ParameterTypeRequiredDescription
pagenumberNoPage number for pagination
limitnumberNoItems per page
calendarIdstring (UUID)NoFilter by calendar ID
serviceIdstring (UUID)NoFilter 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 Availability object.
  • 200 OK (list): Returns a paginated response { items, total, page, limit, pages } of Availability.

See Availability Properties for the object schema.