List Calendar Event Types

Get the properties of the calendar event types available to your company.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

A calendar event type is a named point in the day, such as Opening Hours or Closing Hours, that each location can schedule per day of the week.

Deactivated types are never returned.

Query Params
boolean
Defaults to false

Include company and location_count in each object of the data array.

Case-insensitive search on the calendar event type's name (value).

string
enum

Sort order of result. One of value or id. Specify a descending sort by prefixing with -.

Allowed:
int32
Defaults to 20

Number of results to return per page. Max limit is 100.

int32
Defaults to 0

The initial index from which to return the results.

boolean
Defaults to false

Return only data within the meta key.

Headers
string

Language of the returned value. Types without a translation in that language fall back to their default-language name.

Response

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json