Get publicly bookable slots · Hallify Developers

Authentication

A Hallify account session is not required. Follow this operation’s prerequisites and restrictions.

Connection guide

Parameters

publicHandlePath · Required: Opaque public channel handle used to resolve one venue’s published guest-facing configuration; it is not a credential.
string
Full definition
{ "type": "string", "example": "example" }
originHeader · Required: Browser Origin evaluated against the public channel allowlist; a missing or disallowed origin is rejected without exposing private venue configuration.
string
Full definition
{ "type": "string", "example": "example" }
servicePeriodIdQuery · Optional: Optional Hallify UUID filter for service period.
string · uuid
Full definition
{ "format": "uuid", "type": "string", "example": "9b6163a8-afea-4877-818b-8e2ae28a2845" }
partySizeQuery · Required: Number of guests used to evaluate capacity and guest-bookable availability.
integer
Full definition
{ "minimum": 1, "maximum": 99, "type": "integer", "example": 1 }
dateQuery · Required: Venue-local business date evaluated by this operation, serialized as YYYY-MM-DD without a time of day.
string
Full definition
{ "type": "string", "example": "example" }

Responses

200Returns available public booking slots and their service-period context.

ReservationAvailabilityDto

Full definition

{
  "$ref": "#/components/schemas/ReservationAvailabilityDto"
}

Example response · 200 · application/json

[
  {
    "scheduledAt": "2026-01-15T12:00:00.000Z",
    "endsAt": "2026-12-31T18:00:00.000Z",
    "occupancyEndsAt": "2026-12-31T18:00:00.000Z",
    "offset": "example",
    "servicePeriodId": "4846c409-f4df-40f6-81cc-1d7157a5c646"
  }
]

Schemas

ReservationAvailabilityDto

Returns available staff booking slots and their capacity context.

Full definition

{
  "type": "array",
  "items": {
    "type": "object",
    "required": [
      "scheduledAt",
      "endsAt",
      "occupancyEndsAt",
      "offset",
      "servicePeriodId"
    ],
    "properties": {
      "scheduledAt": {
        "type": "string",
        "format": "date-time",
        "description": "RFC 3339 timestamp for scheduled at; offsets represent the same absolute instant.",
        "example": "2026-01-15T12:00:00.000Z"
      },
      "endsAt": {
        "type": "string",
        "format": "date-time",
        "description": "RFC 3339 timestamp for ends at; offsets represent the same absolute instant.",
        "example": "2026-12-31T18:00:00.000Z"
      },
      "occupancyEndsAt": {
        "type": "string",
        "format": "date-time",
        "description": "RFC 3339 timestamp for occupancy ends at; offsets represent the same absolute instant.",
        "example": "2026-12-31T18:00:00.000Z"
      },
      "offset": {
        "type": "string",
        "description": "Offset for reservations availability item.",
        "example": "example"
      },
      "servicePeriodId": {
        "type": "string",
        "format": "uuid",
        "description": "Hallify UUID identifying service period associated with reservations availability item.",
        "example": "4846c409-f4df-40f6-81cc-1d7157a5c646"
      }
    },
    "example": {
      "scheduledAt": "2026-01-15T12:00:00.000Z",
      "endsAt": "2026-12-31T18:00:00.000Z",
      "occupancyEndsAt": "2026-12-31T18:00:00.000Z",
      "offset": "example",
      "servicePeriodId": "4846c409-f4df-40f6-81cc-1d7157a5c646"
    }
  },
  "description": "Returns available staff booking slots and their capacity context.",
  "example": [
    {
      "scheduledAt": "2026-01-15T12:00:00.000Z",
      "endsAt": "2026-12-31T18:00:00.000Z",
      "occupancyEndsAt": "2026-12-31T18:00:00.000Z",
      "offset": "example",
      "servicePeriodId": "4846c409-f4df-40f6-81cc-1d7157a5c646"
    }
  ]
}