Types

API Docs

Data Types

The following is a list of data types used within the calendsa API:

NameDefinitionExample
StringA string is a sequence of characters. "value"
IntegerAn integer is a number without decimals. 1234
FloatA float is a number with decimals. 12.34
BooleanA boolean is a type of two possible values representing true or false. true
DateA date is a moment in time in ISO 8601 format. "2023-02-09T09:53:27.632Z"
DurationA duration is relative time in ISO 8106 format. "PT2H30M"
EnumAn enum is a string with only a few possible valid values. A | B
ListA data structure with only a list of values separated by a comma. ["value", 1234, 12.34]
MapA data structure with a list of values assigned to a unique key. { "key": "value" }

Data Catalog

Provides a comprehensive and standardized interface for data consumers to access and utilize the REST resources available through the API.

Appointment

AppointmentLog

Business

Currency

Customer

Custom Question Answer

Day of Week

Duration

Location Type

Pricing Type

Role

Scheduling Policy

Service Category

Service

Team Member

Time Slot

Time Off

Time Zone

Work Hours

Work Time Slot

Webhook

Webhook Trigger Event