Skip to main content
GET
Find patients

Authorizations

Authorization
string
header
required

Bearer access token issued by Peerlogic.

Query Parameters

practice_id
string
required

Practice ID.

phone_number
string

Client or patient phone number in E.164 format.

name
string

Patient name.

date_of_birth
string<date>

Patient date of birth.

email
string<email>

Client or patient email address.

is_active
boolean
default:true

Whether the patient is active.

species
string

Species name.

breed
string

Breed name.

sex
string

Patient sex.

color
string

Patient color.

entity_type
string

Patient record type.

sort
enum<string>
default:best_match

Result ordering.

Available options:
best_match,
name,
-name
page
integer

Page number.

Required range: x >= 1
page_size
integer

Number of records to return per page.

Required range: x >= 1

Response

Paginated matching patients.

count
integer
required

Total number of matching records.

results
object[]
required
next
string<uri> | null

URL for the next page, when available.

previous
string<uri> | null

URL for the previous page, when available.