TimeZest API Documentation

Use the TimeZest API to access data from your TimeZest account, and to programmatically trigger scheduling requests.

Getting started

To get started, create a new API Key in your API Keys, then read about how to make requests for the resources you need to access using our HTTP APIs.

Guides

Authentication

Learn how to authenticate your API requests.

Read more

Pagination

Understand how to work with paginated responses.

Read more

Errors

Read about the different types of errors returned by the API.

Read more

TimeZest Query Language

Learn how to filter the results returned by the API.

Read more

Endpoints

Agents

Learn about the agent object and how to retrieve agents.

Appointment Types

Learn about the appointment type object and how to retrieve them.

Scheduling Requests

Learn about the scheduling request object and how to create and retrieve them.

Teams

Learn about the team model and how to retrieve them.