List 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>"
      }
    ]
  },
  "message": "<string>"
}

GET

services

core

open_api

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>"
      }
    ]
  },
  "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

Show child attributes

data.page

integer

required

data.per_page

integer

required

data.total_pages

integer

required

data.total_count

integer

required

data.content

object[]

required

An array of appointments

Show child attributes

data.content.id

string

The ID of the appointment

data.content.remote_id

string

The remote ID of the appointment (The ID in the PIMS)

data.content.status

string

The status of the appointment. 'REQUESTED', 'ACCEPTED', 'CONFIRMED', 'DELETED', 'IN_PROGRESS', 'DECLINED', 'DONE'

data.content.booking_date

string<date-time>

The start date/time of the appointment in ISO 8601 format

data.content.end_date

string<date-time>

The end date/time of the appointment in ISO 8601 format

data.content.created_at

string<date-time>

The date/time the appointment was created in ISO 8601 format

data.content.updated_at

string<date-time>

The date/time the appointment was last updated in ISO 8601 format

data.content.referral_source

string

If a referral source (utm_source) was provided to the session in which the appointment was booked online, it will be returned here

data.content.referral_campaign

string

If a referral campaign (utm_campaign) was provided to the session in which the appointment was booked online, it will be returned here

data.content.referral_medium

string

If a referral medium (utm_medium) was provided to the session in which the appointment was booked online, it will be returned here

data.content.client_first_name

string

The first name of the client that booked the appointment

data.content.client_last_name

string

The last name of the client that booked the appointment

data.content.client_email

string

The email address of the client that booked the appointment

data.content.client_phone

string

The phone number of the client that booked the appointment

data.content.client_type

string

The type of client that booked the appointment. 'NEW' or 'RETURNING'

data.content.patient_name

string

The name of the patient that booked the appointment

message

string

Search Open Times Create Appointment

⌘I

API Documentation

Authentication

Open Times Endpoints

Appointments Endpoints

Clients Endpoints

Patients Endpoints

Authorizations

Headers

Query Parameters

Response