Telehealth Public APIs
  1. General APIs
Telehealth Public APIs
  • Introduction
  • SSO Login
    • Generate SSO token
      POST
    • SSO Login
      GET
  • General APIs
    • Create Patient
      POST
    • Upload Patient File
      POST
    • Submit Patient's Form Response
      POST
    • Lab readings
      POST
    • Assign Service to Patient
      POST
    • Create Patient's Chart Note
      POST
    • Get Provider's Appointment Slots
      POST
    • Provider Sign Up
      POST
    • GraphQL Get Patient(s)
      POST
  1. General APIs

Get Provider's Appointment Slots

POST
/api/service/v1/appointment-slots

POST /api/service/v1/appointment-slots#

This endpoint is used to retrieve available appointment slots for a provider's specific service on a given date.

Request Body#

provider_email (string): Required. The email of the provider.
service_id (integer): Requeired. The ID of the service. You can get it from Provider Portal -> Configurations Menu -> Appointment Config -> Appointment Services Tab -> Service ID column.
date (date): Required. The date must be in YYYY-MM-DD format for which the available slots are requested.
timezone (string): Optional. The timezone for the date e.g. Asia/Kolkata

Response#

The response is in JSON format and has the following schema:
{
    "available_slots": ["array of slots"]
}
The available_slots key in the response contains an array of available slots for the specified date and service.

Example Response#

{
    "available_slots": ["09:00 AM", "10:00 AM", "11:00 AM"]
}

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Header Params

Body Params application/json

Example
{
    "provider_email": {{email}},
    "service_id": {{serviceid}},
    "date": {{date}},
    "timezone": {{timezone}}
}

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/api/service/v1/appointment-slots' \
--header 'Accept: application/json' \
--header 'customer-code: {{customer_code}}' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "provider_email": {{email}},
    "service_id": {{serviceid}},
    "date": {{date}},
    "timezone": {{timezone}}
}'

Responses

🟢200Example Request
application/json
Body

Example
{
    "available_slots": [
        "09:00",
        "09:30",
        "10:00",
        "10:30",
        "11:00",
        "11:30",
        "12:00",
        "12:30",
        "13:00",
        "13:30",
        "14:00",
        "14:30",
        "15:00",
        "15:30",
        "16:00",
        "16:30",
        "17:00",
        "17:30"
    ]
}
Modified at 2024-08-01 04:57:38
Previous
Create Patient's Chart Note
Next
Provider Sign Up
Built with