Skip to main content
GET
List people

Authorizations

Authorization
string
header
required

OAuth 2.1 access token.

Query Parameters

page
integer
default:1

Page number.

Required range: x >= 1
per_page
integer
default:50

Number of records per page. Maximum: 50.

Required range: 1 <= x <= 50
order_by
enum<string>
default:created_at

Field to sort by.

Available options:
created_at,
updated_at,
full_name
order
enum<string>
default:desc

Sort direction.

Available options:
asc,
desc
full_name
string

Filter by name (case-insensitive contains).

email
string<email>

Filter by email address (contains). Partial match across all emails on the contact.

phone
string

Filter by phone number (contains). Partial match across all phones on the contact.

company_id
string<uuid>

Filter by company UUID. Returns only people linked to this company.

has_email
boolean

Filter to return only people who have an email (true) or who do not have an email (false).

has_phone
boolean

Filter to return only people who have a phone (true) or who do not have a phone (false).

created_after
string<date-time>

Return records created on or after this ISO 8601 date.

created_before
string<date-time>

Return records created on or before this ISO 8601 date.

updated_after
string<date-time>

Return records updated on or after this ISO 8601 date.

updated_before
string<date-time>

Return records updated on or before this ISO 8601 date.

Response

People returned successfully.

data
object[]
meta
object