Skip to main content
GET
Find contacts

Authorizations

Authorization
string
header
required

Bearer access token issued by Peerlogic.

Query Parameters

practice_ids
string[]
required

One or more practice IDs to search.

phone_number
string

Caller phone number in E.164 format.

Search by contact name, phone number, or email address.

ordering
enum<string>
default:recent_message

Result ordering.

Available options:
recent_message,
unread_message,
relevance
id
string[]

Limit results to one or more contact IDs.

Limit results based on whether the contact is linked to a patient.

next_appointment_at__gte
string<date-time>

Return contacts whose next appointment is at or after this timestamp.

next_appointment_at__lte
string<date-time>

Return contacts whose next appointment is at or before this timestamp.

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 contacts.

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.