Segment List
Get Segment List Subscribers
Changed onRetrieves 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
Request
- Base URLhttps://api-docs.ministrybytext.com (the document declares no server; this is the origin it was published from)
- Authnone declared
- TypeScriptA function with typed inputs. Its response is checked against the schema.
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
Changes
- info
added the optional property
///to the response with the status
- info
- info
endpoint added
- info