v1

latestSwagger 2.02026-08-06114161439.7 KB
SMS Broadcast

Get contacts in a contact list

Retrieve contacts in a specific contact list

get/contact-lists/{id}/contacts

Path parameters

idinteger required

The ID of the contact list to retrieve contacts from

Query parameters

pageinteger

1-based page number for paginated results. Integer, default 1, min 1. Alternative to offset; used by SMS Broadcast endpoints.

limitinteger

Maximum number of records to return per page. Integer, default 100, max 2000, min 1.

filterstring[]

Comma separated list of field column name with conditional (=, !=, <=, >=, >, <, like) followed by the value to compare against, Please make sure to add spaces after and before while using "like" operator example "first_name like test_name". Filterable fields include phone_number, first_name, created_at.

Response

Contact list contacts retrieved successfully

resultstring required

Outcome of the request. String, typically 'success' or 'error'.

errstring required

Error message when result='error'. String. Empty/null on success.

datastring

Response payload. Shape varies by endpoint.