Skip to content

List segment contacts

If you have questions regarding this API, please visit our API FAQ page.

Listing segment contacts

Make a GET request to https://webapi.inboxroad.com/api/v2/segments/{segment_id}/contacts/ with a valid X-API-Key.

Terminal window
curl -X GET 'https://webapi.inboxroad.com/api/v2/segments/{segment_id}/contacts/' \
-H 'X-API-Key: <your_token>' \
-H 'Content-Type: application/json'

Path parameters

Param nameDescription
segment_idUnique identifier of the segment (UUID).

Response fields

Field nameDescription
paginationPagination metadata for the results.
itemsMatching contact records.

Each item is a contact record whose keys are the union of the source contact lists’ field schemas (defaults plus any custom fields). See Get contact list for how field schemas are described.

Example response

{
"pagination": {
"page": 1,
"page_size": 25,
"total_count": 1824,
"total_pages": 73
},
"items": [
{
"id": 4821,
"email": "john.doe@example.com",
"first_name": "John",
"last_name": "Doe",
"status": "subscribed",
"plan": "pro"
}
]
}

Query parameters

Param namePossible valuesDescription
pageInteger1-based page number. Default 1.
page_sizeIntegerNumber of contacts per page. Default 25.
searchStringKeyword search across the contacts’ text fields.

Possible response codes

Status codeDescription
200Contacts retrieved successfully (empty if the segment is not yet DONE).
401Unauthorized.
404Segment not found.