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

/v1/appointments/slots

Query parameters

timezonestring

staffIdstring

datestring

locationIdstring

nextThreeDaysstring

serviceIdstring

Header parameters

x-api-keystringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '<YOUR HOST>/v1/appointments/slots' \
  --header 'x-api-key: text'

200

200

[
  {
    "date": "2025-02-23T08:04:15.944Z",
    "timezone": "text",
    "slots": [
      {
        "startTime": "text",
        "endTime": "text"
      }
    ]
  }
]

200 response

Search or Retrieve Appointments

get

/v1/appointments

Query parameters

limitstring

staffIdstring

clientIdstring

endDatestring

locationIdstring

pagestring

startDatestring

Header parameters

x-api-keystringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '<YOUR HOST>/v1/appointments' \
  --header 'x-api-key: text'

200

200

[
  {
    "id": "text",
    "date": "2025-02-23",
    "time": "text",
    "timezone": "text",
    "startTimeUTC": "2025-02-23T08:04:15.944Z",
    "startTime": "2025-02-23T08:04:15.944Z",
    "endTimeUTC": "2025-02-23T08:04:15.944Z",
    "endTime": "2025-02-23T08:04:15.944Z",
    "bookedFrom": "text",
    "status": "text",
    "appointmentType": "text",
    "paymentStatus": "text",
    "location": {
      "id": "text",
      "title": "text"
    },
    "client": {
      "id": "text",
      "fullName": "text"
    },
    "staff": {
      "id": "text",
      "name": "text"
    },
    "service": {
      "id": "text",
      "name": "text",
      "durationMinutes": 1,
      "sellingPrice": 1
    },
    "addOnServices": [
      {
        "id": "text",
        "name": "text",
        "durationMinutes": 1,
        "sellingPrice": 1
      }
    ]
  }
]

200 response

Get Individual Appointment By Id

get

/v1/appointments/{appointmentId}

Path parameters

appointmentIdstringrequired

Header parameters

x-api-keystringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '<YOUR HOST>/v1/appointments/{appointmentId}' \
  --header 'x-api-key: text'

200

200

{
  "id": "text",
  "date": "2025-02-23",
  "time": "text",
  "timezone": "text",
  "startTimeUTC": "2025-02-23T08:04:15.944Z",
  "startTime": "2025-02-23T08:04:15.944Z",
  "endTimeUTC": "2025-02-23T08:04:15.944Z",
  "endTime": "2025-02-23T08:04:15.944Z",
  "bookedFrom": "text",
  "status": "text",
  "appointmentType": "text",
  "paymentStatus": "text",
  "location": {
    "id": "text",
    "title": "text"
  },
  "client": {
    "id": "text",
    "fullName": "text"
  },
  "staff": {
    "id": "text",
    "name": "text"
  },
  "service": {
    "id": "text",
    "name": "text",
    "durationMinutes": 1,
    "sellingPrice": 1
  },
  "addOnServices": [
    {
      "id": "text",
      "name": "text",
      "durationMinutes": 1,
      "sellingPrice": 1
    }
  ]
}

200 response

Book Appointment

post

/v1/appointments

Header parameters

x-api-keystringrequired

Body

datestring · daterequired

timestringrequired

overrideTimeSlotValidationboolean

timezonestring

notesstring

clientobjectrequired

locationobjectrequired

serviceobjectrequired

staffobject

addOnServicesobject[]

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '<YOUR HOST>/v1/appointments' \
  --header 'x-api-key: text' \
  --header 'Content-Type: application/json' \
  --data '{"date":"2025-02-23","time":"text","client":{},"location":{"id":"text"},"service":{"id":"text"},"staff":{"id":"text"},"addOnServices":[{}]}'

200

200

{
  "id": "text",
  "date": "2025-02-23",
  "time": "text",
  "timezone": "text",
  "startTimeUTC": "2025-02-23T08:04:15.944Z",
  "startTime": "2025-02-23T08:04:15.944Z",
  "endTimeUTC": "2025-02-23T08:04:15.944Z",
  "endTime": "2025-02-23T08:04:15.944Z",
  "bookedFrom": "text",
  "status": "text",
  "appointmentType": "text",
  "paymentStatus": "text",
  "location": {
    "id": "text",
    "title": "text"
  },
  "client": {
    "id": "text",
    "fullName": "text"
  },
  "staff": {
    "id": "text",
    "name": "text"
  },
  "service": {
    "id": "text",
    "name": "text",
    "durationMinutes": 1,
    "sellingPrice": 1
  },
  "addOnServices": [
    {
      "id": "text",
      "name": "text",
      "durationMinutes": 1,
      "sellingPrice": 1
    }
  ]
}

200 response

Reschedule Appointment

post

/v1/appointments/reschedule

Header parameters

x-api-keystringrequired

Body

appointmentIdstringrequired

datestring · daterequired

timestringrequired

timezonestring

locationobjectrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '<YOUR HOST>/v1/appointments/reschedule' \
  --header 'x-api-key: text' \
  --header 'Content-Type: application/json' \
  --data '{"appointmentId":"text","date":"2025-02-23","time":"text","location":{"id":"text"}}'

200

200

{
  "id": "text",
  "date": "2025-02-23",
  "time": "text",
  "timezone": "text",
  "startTimeUTC": "2025-02-23T08:04:15.944Z",
  "startTime": "2025-02-23T08:04:15.944Z",
  "endTimeUTC": "2025-02-23T08:04:15.944Z",
  "endTime": "2025-02-23T08:04:15.944Z",
  "bookedFrom": "text",
  "status": "text",
  "appointmentType": "text",
  "paymentStatus": "text",
  "location": {
    "id": "text",
    "title": "text"
  },
  "client": {
    "id": "text",
    "fullName": "text"
  },
  "staff": {
    "id": "text",
    "name": "text"
  },
  "service": {
    "id": "text",
    "name": "text",
    "durationMinutes": 1,
    "sellingPrice": 1
  },
  "addOnServices": [
    {
      "id": "text",
      "name": "text",
      "durationMinutes": 1,
      "sellingPrice": 1
    }
  ]
}

200 response

Cancel Appointment

post

/v1/appointments/cancel

Header parameters

x-api-keystringrequired

Body

appointmentIdstringrequired

cancellationReasonstring

locationobjectrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '<YOUR HOST>/v1/appointments/cancel' \
  --header 'x-api-key: text' \
  --header 'Content-Type: application/json' \
  --data '{"appointmentId":"text","location":{"id":"text"}}'

200

200

{}

200 response