Skip to main content
GET
/
services
/
core
/
open_api
/
v1
/
patients
cURL
curl --request GET \
  --url https://partner-api.getoliver.com/services/core/open_api/v1/patients \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Client-Id: <x-client-id>'
{
  "success": true,
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "client_id": "<string>",
      "species": "<string>",
      "breed": "<string>"
    }
  ],
  "message": "<string>"
}

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

​
client_id
string
required

The ID of the client whose patients to list

​
name
string

Optionally filter patients by name

Response

List of patients found

​
success
boolean
required
​
data
object[]
required
​
message
string