Skip to main content
GET
List people

Authorizations

Authorization
string
header
required

OAuth 2.0 Bearer Token from Clerk authentication

Query Parameters

page
integer

Page number

per_page
integer

Items per page (1-100, default: 25). Values over 100 will be clamped to 100.

Required range: 1 <= x <= 100
book_id
string

Filter by book ID

role_type
enum<string>

Filter by entity type

Available options:
client,
prospect,
contact,
past_client
include_past_clients
enum<string>

Include past clients in results (default: false)

Available options:
true,
false
email
string

Filter by exact email match after normalization

phone
string

Filter by exact phone match (E.164 format)

name
string

Filter by person name (prefix/full-text match, not arbitrary substring)

Response

successful

data
object[]
required
pagination
object
required