Appointments

This API documentation serves as your guide to interacting with the appointment management system within Whautomate. It allows you to sync appointments between multiple systems

The API offers a variety of functionalities through the following methods:

• Generate Available Slots:

  This method retrieves information about available appointment slots within a specific timeframe.

• Search or Retrieve Appointments:

  This method allows you to search for existing appointments based on various criteria (e.g., date range, participant, service or staff). You can also retrieve a list of all appointments.

• Get Individual Appointment By Id:

  This method retrieves detailed information about a specific appointment by providing its unique identifier.

• Book Appointment:

  This method allows you to create a new appointment by specifying details like date, time, service, and participants.

• Reschedule Appointment:

  This method enables you to reschedule an existing appointment, potentially modifying date, time, or other relevant details.

• Cancel Appointment:

  This method allows you to cancel an existing appointment, removing it from the schedule.

By leveraging this API, you can streamline the appointment management process, ensuring efficient scheduling and access to appointment information.

Generate available Slots

GET<YOUR HOST>/v1/appointments/slots

Query parameters

Header parameters

Response

200

200 response

Body

application/json

date*string (date-time)

timezone*string

slots*array of object

Request

JavaScriptCurlPython

const response = await fetch('<YOUR HOST>/v1/appointments/slots', {
    method: 'GET',
    headers: {
      "x-api-key": "text"
    },
});
const data = await response.json();

Response

200

[
  {
    "date": "2024-11-21T06:26:25.013Z",
    "timezone": "text",
    "slots": [
      {
        "startTime": "text",
        "endTime": "text"
      }
    ]
  }
]

Search or Retrieve Appointments

GET<YOUR HOST>/v1/appointments

Query parameters

Header parameters

Response

200

200 response

Body

application/json

idstring

location*object

client*object

staff*object

date*string (date)

time*string

timezonestring

startTimeUTCstring (date-time)

startTimestring (date-time)

endTimeUTCstring (date-time)

endTimestring (date-time)

service*object

addOnServicesarray of object

bookedFromstring

statusstring

appointmentTypestring

paymentStatusstring

Request

JavaScriptCurlPython

const response = await fetch('<YOUR HOST>/v1/appointments', {
    method: 'GET',
    headers: {
      "x-api-key": "text"
    },
});
const data = await response.json();

Response

200

[
  {
    "id": "text",
    "location": {
      "id": "text",
      "title": "text"
    },
    "client": {
      "id": "text",
      "fullName": "text"
    },
    "staff": {
      "id": "text",
      "name": "text"
    },
    "date": "2024-11-21",
    "time": "text",
    "timezone": "text",
    "startTimeUTC": "2024-11-21T06:26:25.013Z",
    "startTime": "2024-11-21T06:26:25.013Z",
    "endTimeUTC": "2024-11-21T06:26:25.013Z",
    "endTime": "2024-11-21T06:26:25.013Z",
    "service": {
      "id": "text",
      "name": "text",
      "sellingPrice": 0
    },
    "addOnServices": [
      {
        "id": "text",
        "name": "text",
        "sellingPrice": 0
      }
    ],
    "bookedFrom": "text",
    "status": "text",
    "appointmentType": "text",
    "paymentStatus": "text"
  }
]

Get Individual Appointment By Id

GET<YOUR HOST>/v1/appointments/{appointmentId}

Path parameters

appointmentId*string

Header parameters

Response

200

200 response

Body

application/json

idstring

location*object

client*object

staff*object

date*string (date)

time*string

timezonestring

startTimeUTCstring (date-time)

startTimestring (date-time)

endTimeUTCstring (date-time)

endTimestring (date-time)

service*object

addOnServicesarray of object

bookedFromstring

statusstring

appointmentTypestring

paymentStatusstring

Request

JavaScriptCurlPython

const response = await fetch('<YOUR HOST>/v1/appointments/{appointmentId}', {
    method: 'GET',
    headers: {
      "x-api-key": "text"
    },
});
const data = await response.json();

Response

200

{
  "id": "text",
  "location": {
    "id": "text",
    "title": "text"
  },
  "client": {
    "id": "text",
    "fullName": "text"
  },
  "staff": {
    "id": "text",
    "name": "text"
  },
  "date": "2024-11-21",
  "time": "text",
  "timezone": "text",
  "startTimeUTC": "2024-11-21T06:26:25.013Z",
  "startTime": "2024-11-21T06:26:25.013Z",
  "endTimeUTC": "2024-11-21T06:26:25.013Z",
  "endTime": "2024-11-21T06:26:25.013Z",
  "service": {
    "id": "text",
    "name": "text",
    "sellingPrice": 0
  },
  "addOnServices": [
    {
      "id": "text",
      "name": "text",
      "sellingPrice": 0
    }
  ],
  "bookedFrom": "text",
  "status": "text",
  "appointmentType": "text",
  "paymentStatus": "text"
}

Book Appointment

POST<YOUR HOST>/v1/appointments

Header parameters

Body

application/json

client*object

location*object

service*object

date*string (date)

time*string

overrideTimeSlotValidationboolean

staffobject

timezonestring

notesstring

addOnServicesarray of object

Response

200

200 response

Body

application/json

idstring

location*object

client*object

staff*object

date*string (date)

time*string

timezonestring

startTimeUTCstring (date-time)

startTimestring (date-time)

endTimeUTCstring (date-time)

endTimestring (date-time)

service*object

addOnServicesarray of object

bookedFromstring

statusstring

appointmentTypestring

paymentStatusstring

Request

JavaScriptCurlPython

const response = await fetch('<YOUR HOST>/v1/appointments', {
    method: 'POST',
    headers: {
      "x-api-key": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "client": {},
      "date": "2024-11-21",
      "location": {
        "id": "text"
      },
      "service": {
        "id": "text"
      },
      "time": "text"
    }),
});
const data = await response.json();

Response

200

{
  "id": "text",
  "location": {
    "id": "text",
    "title": "text"
  },
  "client": {
    "id": "text",
    "fullName": "text"
  },
  "staff": {
    "id": "text",
    "name": "text"
  },
  "date": "2024-11-21",
  "time": "text",
  "timezone": "text",
  "startTimeUTC": "2024-11-21T06:26:25.013Z",
  "startTime": "2024-11-21T06:26:25.013Z",
  "endTimeUTC": "2024-11-21T06:26:25.013Z",
  "endTime": "2024-11-21T06:26:25.013Z",
  "service": {
    "id": "text",
    "name": "text",
    "sellingPrice": 0
  },
  "addOnServices": [
    {
      "id": "text",
      "name": "text",
      "sellingPrice": 0
    }
  ],
  "bookedFrom": "text",
  "status": "text",
  "appointmentType": "text",
  "paymentStatus": "text"
}

Reschedule Appointment

POST<YOUR HOST>/v1/appointments/reschedule

Header parameters

Body

application/json

appointmentId*string

location*object

date*string (date)

time*string

timezonestring

Response

200

200 response

Body

application/json

idstring

location*object

client*object

staff*object

date*string (date)

time*string

timezonestring

startTimeUTCstring (date-time)

startTimestring (date-time)

endTimeUTCstring (date-time)

endTimestring (date-time)

service*object

addOnServicesarray of object

bookedFromstring

statusstring

appointmentTypestring

paymentStatusstring

Request

JavaScriptCurlPython

const response = await fetch('<YOUR HOST>/v1/appointments/reschedule', {
    method: 'POST',
    headers: {
      "x-api-key": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "appointmentId": "text",
      "date": "2024-11-21",
      "location": {
        "id": "text"
      },
      "time": "text"
    }),
});
const data = await response.json();

Response

200

{
  "id": "text",
  "location": {
    "id": "text",
    "title": "text"
  },
  "client": {
    "id": "text",
    "fullName": "text"
  },
  "staff": {
    "id": "text",
    "name": "text"
  },
  "date": "2024-11-21",
  "time": "text",
  "timezone": "text",
  "startTimeUTC": "2024-11-21T06:26:25.013Z",
  "startTime": "2024-11-21T06:26:25.013Z",
  "endTimeUTC": "2024-11-21T06:26:25.013Z",
  "endTime": "2024-11-21T06:26:25.013Z",
  "service": {
    "id": "text",
    "name": "text",
    "sellingPrice": 0
  },
  "addOnServices": [
    {
      "id": "text",
      "name": "text",
      "sellingPrice": 0
    }
  ],
  "bookedFrom": "text",
  "status": "text",
  "appointmentType": "text",
  "paymentStatus": "text"
}

Cancel Appointment

POST<YOUR HOST>/v1/appointments/cancel

Header parameters

Body

application/json

appointmentId*string

location*object

cancellationReasonstring

Response

200

200 response

Body

application/json

Empty Schema

Request

JavaScriptCurlPython

const response = await fetch('<YOUR HOST>/v1/appointments/cancel', {
    method: 'POST',
    headers: {
      "x-api-key": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "appointmentId": "text",
      "location": {
        "id": "text"
      }
    }),
});
const data = await response.json();