latestOpenAPI 3.0.12026-08-1848115403.9 KB

ae1e3ddfb2fb

Segment List

Get Segment List Subscribers

Retrieves a paginated list of subscribers associated with a specific segment list. The response contains subscriber profiles including contact details, geographic regions, and profile image URLs.

get/accounts/segment-lists/{listId}/subscribers

Path parameters

listIdstring required

The unique identifier of the segment list whose subscribers are being retrieved.

Query parameters

searchstring

Filters subscribers within the list by matching alphanumeric characters against their phone number (subscriberNo), first name, or last name.

pageNumberinteger required

Specifies the page index of the results to retrieve. Must be greater than or equal to 1.

pageSizeinteger required

Controls the maximum number of orgunit returned per page. Accepts values between 1 and 1000.

Response

Success

appCodestring nullable
messagestring nullable
isErrorboolean