/v1/appointment/book/schedule/day-time

Retrieves the list of available appointment time slots for a specific service at a given location and date.

Purpose

Use this endpoint to check which appointment times are available for booking for a particular service on a specific day at a specific location and business region.

HTTP Method

GET /v1/appointment/book/schedule/day-time

Required Query Parameters

id_region (integer/string)

Identifier of the region in which the business operates.

k_business (integer/string)

Unique key of the business.

k_location (integer/string)

Unique key of the physical/location where the appointment will take place.

k_service (integer/string)

Unique key of the service for which you are checking availability.

dt_date (string)

Date for which to retrieve available times.

Format: YYYY-MM-DD HH:mm:ss (e.g., 2025-08-24 00:00:00). Typically, the time is set to midnight for a given day.

All of the above query parameters are required. If any are missing or invalid, the API may return an error or an empty time list.

Successful Response (200 OK)

When the request is successful, the response body returns the availability information for the specified date and service.

Sample 200 OK response (from the last successful call):

{
  "a_time": [],
  "dt_date": "2025-08-24 00:00:00",
  "is_waitlist": false,
  "k_location": "315968",
  "status": "ok",
  "s_version": "444085"
}

Response Fields

a_time (array)

List of available time slots for the specified date and service.

Empty array ([]) means there are no available times for that day.

dt_date (string)

The date for which the availability was requested, echoed back by the API.

is_waitlist (boolean)

Indicates whether the client is being considered for a waitlist instead of a direct booking.

k_location (string)

Location key associated with the returned schedule.

status (string)

Overall status of the request processing (e.g., "ok" for success).

s_version (string)

Internal version identifier for the schedule/response payload.

The presence of an empty a_time array with status: "ok" indicates that the request was valid but no appointment times are available for the given inputs.

curl --location -g --request GET '/v1/appointment/book/schedule/day-time?id_region={{id_region}}&k_business={{k_business}}&k_location={{k_location}}&k_service=undefined&dt_date=2025-08-24 00:00:00' \ --header 'Content-Type: text/plain' \ --data-raw ''

Purpose

HTTP Method

Required Query Parameters

Successful Response (200 OK)

Response Fields

Request

Responses

/v1/appointment/book/schedule/day-time

Purpose#

HTTP Method#

Required Query Parameters#

Successful Response (200 OK)#

Response Fields#

Request

Responses

Purpose

HTTP Method

Required Query Parameters

Successful Response (200 OK)

Response Fields