Skip to main content

Find contacts in a contact list

GET 
/api/partner-gateway/v1/contacts/list/:listId/contacts

Returns the contacts belonging to a specific contact list, with optional filters and pagination. This is a convenience endpoint equivalent to calling GET /contacts with the listIds parameter set to the given listId. All the same contact-level filters are available: search (case-insensitive text match against name), gender, isValid, communicationSupported (e.g., SMS, RCS, WHATSAPP), isTest, phoneNumber, email, lastContactType, and lastCampaignType. Results are paginated: page is 0-based, limit defaults to 10 (maximum 1000). Use sortBy to choose the sort field (defaults to fullName) and sortOrder for asc or desc. Use this endpoint to preview the audience of a contact list before assigning it to a campaign, or to verify which contacts were imported after a file upload. Returns 404 if no contact list exists with the given listId under your account. Returns 500 if an unexpected server error occurs.

Request​

Responses​

Contacts retrieved successfully

Last updated on