Skip to main content

Appointment Types

Entity›Datastore›Datastore.AppointmentType

Appointment types categorize appointments (e.g., call, meeting, on-site visit).

Use the Datastore_AppointmentType endpoint to query appointment types.

Endpoints​

List Appointment Types​

GET/v1/odata/Datastore_AppointmentType

Single Appointment Type​

GET/v1/odata/Datastore_AppointmentType({id})

Fields​

Datastore Fields (inherited)​

FieldTypeDescription
NameStringDisplay name
CodeStringUnique code identifier
LocalizedNameStringLocalized display name
IsDefaultBooleanWhether this is the default value

Relationships​

RelationshipTarget EntityCardinalityDescription
AppointmentActivity_Appointment1:NAppointment

Expanding Relationships​

GET/v1/odata/Datastore_AppointmentType({id})?$expand=Appointment
GET/v1/odata/Datastore_AppointmentType({id})/Appointment

Filtering Examples​

GET/v1/odata/Datastore_AppointmentType?$filter=Name eq '{Name}'&$top={top}
GET/v1/odata/Datastore_AppointmentType?$filter=contains(Name, '{Name}')&$top={top}
GET/v1/odata/Datastore_AppointmentType?$filter=Code eq '{Code}'&$top={top}
GET/v1/odata/Datastore_AppointmentType?$filter=IsDefault eq {IsDefault}&$top={top}

Custom Query​

Build your own OData query against Datastore_AppointmentType. Open Run and edit the whole request inline — swap the entity set, change the $filter, or add $expand, $select, $orderby, $top, $skip. Type $ for suggestions; use ↺ Reset to restore this example.

GET/v1/odata/Datastore_AppointmentType?$top=10