Appointment Types

An appointment type describes a specific type of appointment that can be booked with TimeZest.

The Appointment Type object

An appointment type in TimeZest defines the details of an appointment that can be book, with details such as its name as well as parameters to be passed to the scheduling engine when determining potential appointment times to offer the end user.

  • Name
    id
    Type
    string
    Description

    Unique identifier for the appointment type.

  • Name
    object
    Type
    string
    Description

    The type of the object. For an appointment type, this will always be the string appointment_type.

  • Name
    internal_name
    Type
    string
    Description

    The internal name of the appointment type. TimeZest uses the internal name when displaying the appointment type to agents and administrators.

  • Name
    external_name
    Type
    string
    Description

    The external name of the appointment type. TimeZest uses the external name when displaying the appointment type to end users. This property may be null, in which case the internal name should be used.

  • Name
    duration_mins
    Type
    integer
    Description

    The default duration of the appointment, in minutes.

  • Name
    url_slug
    Type
    string
    Description

    The URL Slug for the appointment type, which is the identifier used in URLs built in TimeZest to enable appointments to be scheduled with shareable URLs or URL-based scheduling. This property may be null.

  • Name
    created_at
    Type
    timestamp
    Description

    The time the appointment type was created.

  • Name
    updated_at
    Type
    timestamp
    Description

    The most recent time the appointment type was updated.

Example Appointment Type object

{
  "id": "apty_2s211C0S1I5gqIaA8wbDu6",
  "object": "appointment_type",
  "internal_name": "Phone Call [Gold Clients Only]",
  "external_name": "Phone Call",
  "duration_mins": 15,
  "url_slug": "phone-call",
  "created_at": 1692172402,
  "updated_at": 1692172694
}
GET/v1/appointment_types

Retrieve all appointment types

This endpoint returns a list of all appointment types.

The response returned will be a paginated list object, whose data field will be an array of Appointment Type objects as detailed above.

Supported TQL Attributes

The appointment types endpoint can be filtered using the following TQL attributes:

AttributeTypeSupported Operators
appointment_type.internal_nameStringEQ, NOT_EQ, LIKE, NOT_LIKE, IN, NOT_IN
appointment_type.external_nameStringEQ, NOT_EQ, LIKE, NOT_LIKE, IN, NOT_IN
appointment_type.duration_minsIntegerEQ, NOT_EQ, LT, LTE, GT, GTE
appointment_type.url_slugStringEQ, NOT_EQ, LIKE, NOT_LIKE, IN, NOT_IN

Request

  curl https://api.timezest.com/v1/appointment_types \
  -H "Authorization: Bearer <Your API Token>"

Response

{
  "object": "list",
  "next_page": "https://api.timezest.com/v1/appointment_types?starting_after=apty_xQGOfk4xI2VNXoQ6bqKMO",
  "previous_page": null,
  "data": [
    {
      "id": "apty_2s211C0S1I5gqIaA8wbDu6",
      "object": "appointment_type",
      "internal_name": "Phone Call [Gold Clients Only]",
      "external_name": "Phone Call",
      "duration_mins": 15,
      "url_slug": "phone-call",
      "created_at": 1692172402,
      "updated_at": 1692172694
    },
    {
      "id": "apty_xQGOfk4xI2VNXoQ6bqKMO",
      "object": "appointment_type",
      "internal_name": "Remote Desktop Session",
      "external_name": null,
      "duration_mins": 30,
      "url_slug": "remote-desktop",
      "created_at": 1692165109,
      "updated_at": 1692165109
    },
  ]
}