Counts

The ability to easily show a total number of available time slots.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Find total available time slots for resource

In time kit you can create a new project and configure store opening hours and define default length of the appointment and future limit.

Event setting screen:

964

Project opening hours setting screen:

1089

When you pass project_id in your request payload it will inherit above settings by default. /v2/availability/count endpoint will use your project settings to figure out available time slots for your resource.

Project level settings can be override with your resource allow/block availability constraints. For example: if your project allows Monday 9-5PM time available however in your resource settings you override opening hours that will affect your count endpoint results.

845

In above case you will only see time slots count only for Monday because you have blocked other days in your resource settings.

Body Params
string
Defaults to now

Defines the beginning of the search-space written is human language, eg. "1 day", "2 weeks" or "tomorrow"

string
Defaults to 4 weeks

Defines the end of the search-space written is human language, eg. "1 day", "2 weeks" or "tomorrow" (max 6 months)

string

If you're using our projects model, specify the project ID and all parameters to the endpoint will be retrieved dynamically from the project. Any additional parameters in the request are not required and will override those set in the project.

resources
array of strings

Array of resource IDs that should be included in the availability search

resources
string
Defaults to 1 hour

How long each available time-slot should be. "Null" simply returns timeslots in dynamic intervals without a fixed length.

string

The amount of buffer time you want to pad around existing events https://developers.timekit.io/reference/query-availability-v2#section-buffer-time

string

Define at which time increments the time-slots should start. Please see the note

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json