Skip to main content
GET
/
services
/
core
/
open_api
/
v1
/
appointments
cURL
curl --request GET \
  --url https://partner-api.getoliver.com/services/core/open_api/v1/appointments \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Client-Id: <x-client-id>'
{
  "success": true,
  "data": {
    "page": 123,
    "per_page": 123,
    "total_pages": 123,
    "total_count": 123,
    "content": [
      {
        "id": "<string>",
        "remote_id": "<string>",
        "status": "<string>",
        "booking_date": "2023-11-07T05:31:56Z",
        "end_date": "2023-11-07T05:31:56Z",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "referral_source": "<string>",
        "referral_campaign": "<string>",
        "referral_medium": "<string>",
        "client_first_name": "<string>",
        "client_last_name": "<string>",
        "client_email": "<string>",
        "client_phone": "<string>",
        "client_type": "<string>",
        "patient_name": "<string>",
        "remote_client_id": "<string>",
        "remote_patient_id": "<string>"
      }
    ]
  },
  "message": "<string>"
}
This endpoint is currently proposed and subject to change. Functionality, request/response structure, and availability may be modified or removed in future releases. Use with caution in production environments.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
X-Client-Id
string
required

The location id of the practice

Query Parameters

​
updated_at_start
string<date-time>
required

Start date of the range in which results were last updated

​
updated_at_end
string<date-time>

End date of the range in which results were last updated. If not provided, the current date will be used.

​
page
integer
default:0

Page number

​
per_page
integer
default:50

Number of results per page. Max is 100.

Response

Appointments response

​
success
boolean
required
​
data
object
required
​
message
string