Skip to main content
All CollectionsProduct FeaturesProduct Features
TimeZest API
TimeZest API

How to access data from your TimeZest account using TimeZest APIs.

Jason Casuga avatar
Written by Jason Casuga
Updated over a month ago

The TimeZest APIs are available to gain extra insight into your TimeZest account such as seeing which users are sending the most scheduling requests, how many scheduling requests they are sending within a given period, as well as getting details of the TimeZest appointment types. You can also use the TimeZest APIs to create scheduling requests from outside your PSA and TimeZest. The TimeZest APIs are free to use with your TimeZest account and you can get started right away.

Creating an API key for integrations with TimeZest

If you are using a software tool that has created an integration with TimeZest like Pia or Thread, you will need to generate API key credentials for that application to gain access to your TimeZest account.

To create TimeZest API credentials, follow the steps below:

  1. In the TimeZest app, navigate to API Keys on the left menu

  2. Select the + New API Key button

  3. Add a name to the API key in the Name field

  4. Select the appropriate permissions in the Permissions drop-down. Refer to the integration's documentation to determine their required level of permissions

  5. Select the Save button

  6. Once saved, you'll be able to click into the API key, copy it, and proceed to paste the key into the integration setup

TimeZest API Documentation

To get started, go to https://developer.timezest.com/.

Authentication

You will first need to set up proper authentication by creating your API keys to gain access to the TimeZest APIs.

TimeZest Query Language

To understand how to filter results, read the TimeZest Query Language. This section describes how to create predicates using attributes, operators, and values.

Errors

Lastly, if you run a query and get an error message, use the Errors page to learn what each status code means so you can troubleshoot any error codes.

TimeZest API Endpoints

  • Agents - An actual person who can have an appointment scheduled for them.

  • Appointment Types - Describes a specific type of appointment that can be booked with TimeZest.

  • Resources - An agent or a team who can have an appointment scheduled for them.

  • Scheduling Requests - The record in TimeZest which tracks all the details related to booking an individual appointment.

  • Teams - A group of one or more agents which be assigned to be scheduled.

Did this answer your question?