Skip to main content
GET
/
services
/
core
/
open_api
/
v1
/
clients
cURL
curl --request GET \
  --url https://partner-api.getoliver.com/services/core/open_api/v1/clients \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Client-Id: <x-client-id>'
{
  "success": true,
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "email": "<string>",
      "phone": "<string>",
      "patients": [
        {
          "id": "<string>",
          "name": "<string>",
          "client_id": "<string>",
          "species": "<string>",
          "breed": "<string>"
        }
      ],
      "remote_id": "<string>"
    }
  ],
  "message": "<string>"
}
At least one of name, email, or phone must be provided as a query parameter. Max 100 clients will be returned per request, subject to rate limiting.

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

​
name
string

Filter clients by name

​
email
string

Filter clients by email

​
phone
string

Filter clients by phone

Response

List of clients found

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