Sign in
appointment-types

Bookable slot proposals for the appointment type within a search window

Changed on

ViewSet for AppointmentType CRUD and appointment-type event actions.

get/appointment-types/{id}/bookable-slots/

Request

  • The document declares no server URL.
  • Auth: one of:
    • HTTP bearer
    • API key in cookie sessionid

Path parameters

idstring required

Query parameters

duration_secondsinteger required

Desired event duration, in seconds

limitinteger

Number of results to return per page.

namestring

Filter by partial name match

offsetinteger

The initial index from which to return the results.

search_window_endstring required

End of the search window (ISO 8601)

search_window_startstring required

Start of the search window (ISO 8601)

slot_step_secondsinteger

Search step, in seconds (default 900 = 15min)

Headers

X-Organization-Idstring

Selects the active organization for this request. Optional for callers that belong to exactly one active organization — the single membership is resolved implicitly. Required when the caller has two or more active memberships; omitting it in that case returns 400. If the header names an organization the caller is not an active member of, the server returns 403.

Response

countinteger required
nextstring uri nullable
previousstring uri nullable

Example response

{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100"
}

Changes