# Appointments

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

{% openapi src="/files/XKbqmYpLbwmHfH7drtj3" path="/v1/appointments/slots" method="get" %}
[Whautomate -Your Host.json](https://810714386-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FF8vuadG7OJ1fFdSBZATv%2Fuploads%2FmvrcLbjRCcKuOC0Vzyor%2FWhautomate%20-Your%20Host.json?alt=media\&token=e36abed1-908d-45ba-830f-519a3f5dabff)
{% endopenapi %}

### Search or Retrieve Appointments 

{% openapi src="/files/XKbqmYpLbwmHfH7drtj3" path="/v1/appointments" method="get" %}
[Whautomate -Your Host.json](https://810714386-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FF8vuadG7OJ1fFdSBZATv%2Fuploads%2FmvrcLbjRCcKuOC0Vzyor%2FWhautomate%20-Your%20Host.json?alt=media\&token=e36abed1-908d-45ba-830f-519a3f5dabff)
{% endopenapi %}

### Get Individual Appointment By Id

{% openapi src="/files/XKbqmYpLbwmHfH7drtj3" path="/v1/appointments/{appointmentId}" method="get" %}
[Whautomate -Your Host.json](https://810714386-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FF8vuadG7OJ1fFdSBZATv%2Fuploads%2FmvrcLbjRCcKuOC0Vzyor%2FWhautomate%20-Your%20Host.json?alt=media\&token=e36abed1-908d-45ba-830f-519a3f5dabff)
{% endopenapi %}

### Book Appointment

{% openapi src="/files/XKbqmYpLbwmHfH7drtj3" path="/v1/appointments" method="post" %}
[Whautomate -Your Host.json](https://810714386-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FF8vuadG7OJ1fFdSBZATv%2Fuploads%2FmvrcLbjRCcKuOC0Vzyor%2FWhautomate%20-Your%20Host.json?alt=media\&token=e36abed1-908d-45ba-830f-519a3f5dabff)
{% endopenapi %}

### Reschedule Appointment

{% openapi src="/files/XKbqmYpLbwmHfH7drtj3" path="/v1/appointments/reschedule" method="post" %}
[Whautomate -Your Host.json](https://810714386-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FF8vuadG7OJ1fFdSBZATv%2Fuploads%2FmvrcLbjRCcKuOC0Vzyor%2FWhautomate%20-Your%20Host.json?alt=media\&token=e36abed1-908d-45ba-830f-519a3f5dabff)
{% endopenapi %}

### Cancel Appointment

{% openapi src="/files/XKbqmYpLbwmHfH7drtj3" path="/v1/appointments/cancel" method="post" %}
[Whautomate -Your Host.json](https://810714386-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FF8vuadG7OJ1fFdSBZATv%2Fuploads%2FmvrcLbjRCcKuOC0Vzyor%2FWhautomate%20-Your%20Host.json?alt=media\&token=e36abed1-908d-45ba-830f-519a3f5dabff)
{% endopenapi %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://help.whautomate.com/product-guides/whautomate-rest-api/appointments.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.