v1
latestOpenAPI 3.0.32026-07-14490228.1 KBGet People
This endpoint retrieves all people available to the client.
get/people
Query parameters
pageinteger
The current page of results to retrieve.
per_pageinteger
The number of results to pull back. Allowed values: 25, 50, 100, -1 (for all).
sortstring
The order for record sorting. Allowed values are asc and desc.
orderstring
The field for sorting records. Allowed values: id, name, scope, type, length, status.
searchstring
A value to search the phone_number field by for the request.
search_number_idsinteger[]
The associated number IDs to filter by that the user has interacted with and been added to.
search_segment_idsinteger[]
The associated static segment IDs to filter by that the user has been added to.
search_webform_idsinteger[]
The associated webform IDs to filter by that the user has submitted.
search_sourcesstring[]
The sources people were originally added to the system with. Allowed values are inbound_call, webform.
Response
200
Example response
{
"data": [
{
"id": 1,
"phone_number": "+15555555551",
"added_at": "2021-03-19 14:41:34",
"source": "inbound_call"
}
],
"meta": {
"total": 3,
"count": 3,
"page": 1,
"pages": 1,
"per_page": 25,
"order": "id",
"sort": "DESC"
}
}