​​

Fetch Availability

Purpose

​To fetch availability of appointments across services.

Request URL

https://www.zohoapis.com/bookings/v1/json/availableslots

Headers

Parameter NameDescription
AuthorizationZoho-oauthtoken {{accesstoken}}

Note: The access token can be generated from the developer console.

Request Method

GET

Parameters

Parameters to be passed in the request URL are,

Parameter NameDescription
service_id *The unique id of the service for which availability is to be fetched.

staff_id / group_id /resource_id *

(Any one of the above id is mandatory)

staff_id: The unique id of the staff associated with the service for which availability is to be fetched.

group_id: The unique id of the staff group associated with the service for which availability is to be fetched.

resource_id: The unique id of the resource associated with the service for which availability is to be fetched.

selected_date *The date on which services are checked for availability.
Note: fields marked * are mandatory.

Response Type

JSON

The time format of the slots returned in the response will be based on the option chosen in Zoho Bookings under Settings >General>Basic Information>Time Format.

API Limits

Zoho Bookings Plan/EditionNumber of API calls/day
Free250/per user
Basic1000/per user
Premium3000/per user
Zoho One3000/per user
Note: The API limits are excluding the authorization requests. API counts are calculated between 00:00 and 23:59 hours in the respective time zones.

Related Links

Sample Request

Copiedcurl --location --request GET 'https://www.zohoapis.com/bookings/v1/json/availableslots?service_id=3848021000000027083&staff_id=3848021000000027052&selected_date=30-Apr-2020%10:00:00' \
--header 'Authorization: Zoho-oauthtoken 1000.7b3610d1XXXXXXXXXXXXXXXX087cc3.6282226f615637c467bee7209ce1c0a1'

Sample Response

Copied{
  "response": {
    "returnvalue": {
      "reponse": true,
      "data": [
        "10:00",
        "10:15",
        "10:30",
        "10:45",
        "11:00",
        "11:15",
        "11:30",
        "11:45",
        "12:00",
        "12:15",
        "12:30",
        "12:45",
        "13:00",
        "13:15",
        "13:30",
        "13:45",
        "14:00",
        "14:15",
        "14:30",
        "14:45",
        "15:00",
        "15:15",
        "15:30",
        "15:45",
        "16:00",
        "16:15",
        "16:30",
        "16:45",
        "17:00",
        "17:15",
        "17:30"
      ],
      "time_zone": "Asia/Calcutta"
    },
    "status": "success"
  }
}