Sign in
available-times

Get expanded available times

Changed on

Get expanded available times including recurring instances.

get/available-times/expanded{format}

Request

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

Path parameters

format'.json' required

Query parameters

calendar_idinteger required

Calendar ID to get available times for

end_datetimestring required

End datetime for the range (ISO format)

end_timestring date-time

End time (less than or equal to)

limitinteger

Number of results to return per page.

offsetinteger

The initial index from which to return the results.

start_datetimestring required

Start datetime for the range (ISO format)

start_timestring date-time

Start time (greater than or equal to)

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

  • 193c4a0f6c85Revision changes
    • ○

      added to the /////// response property allOf list for the response status

    • ○

      removed from the /////// response property allOf list for the response status

  • 8e69e8419131Revision changes
    • ○

      added to the /////// response property allOf list for the response status

    • ○

      removed from the /////// response property allOf list for the response status