Skip to main content

Find appointments

Find appointment by id​

Retrieves the details of a specific appointment by its unique ID. This is useful for viewing appointment information such as date, time, client details, and status.

GET {base_url}/appointment/{id}

Example

GET {base_url}/appointment/32

Find appointments by dates​

Fetches a list of appointments with optional filters such as dates, page and limit

The body allows the following fields:

FieldRequiredDescription
initDateYesThe start date of the range for which appointments are to be retrieved.
finalDateYesThe end date of the range for which appointments are to be retrieved.
pageNoThe page number for pagination, defaults to 1 if not provided.
limitNoThe number of appointments per page for pagination, defaults to 10 if not provided.
POST {base_url}/appointment/by/dates

Example

{
    "finalDate": "2024-12-17T05:59:00.000Z",
    "initDate": "2024-07-01T06:00:00.000Z",
    "limit": 5,
    "page": 1
}