people

List People

get/api/people

Query parameters

lifecycle_statusstring nullable
company_idstring uuid nullable
idsstring nullable

Comma-separated person UUIDs

Comma-separated person UUIDs

qstring nullable
sort_bystring nullable

Sort field: name|created_at|lifecycle_status

Sort field: name|created_at|lifecycle_status

sort_orderstring nullable

asc or desc

asc or desc

pageinteger
limitinteger

Response

Successful Response

totalinteger required

Total records matching the query (before pagination)

pageinteger required

Current page number (1-indexed)

limitinteger required

Records per page (default 50, max 200)

has_moreboolean required

True if (page * limit) < total

Changes

No recorded changes to this endpoint across all 1 revision of this API.