v1
latestOpenAPI 3.0.12026-07-2471135326.0 KBSubscribers
List Contacts
This endpoint helps you to return a list of all contacts previously added for a given list. Query parameters and extra filters can be added using list's columns (e.g. email[like]=tester@example.com, age[gt]=30)
get/v3/lists/{listId}/subscribers
Path parameters
listIdinteger required
Provide the unique ID of the list
Query parameters
limitinteger
Use limit operator to limit the number of records returned
skipinteger
Use skip operator to skip the specified number of records.
offsetstring
Use offset operator to search the next record to be consulted
sortstring
Useful to sort returned records (Sorting works only for pagination with skip and limit)
selectstring
Useful to limit fields to return in each records
Response
Successfully retrieved the contacts
Example response
{
"meta": {
"timestamp": 1597166699457,
"transactionId": "70169d77-c165-4795-9932-35b8a3af96fb",
"explain": "a descriptive text"
},
"pagination": {
"offset": "e3293115e2ec5f466c67e047",
"limit": 6,
"next": "5f466c67e047e3293115e2ec",
"page": 1,
"pages": 10,
"total": 1000
},
"items": [
{
"id": "507f1f77bcf86cd799439011",
"to": "584000000001,email@example.com",
"reason": "UNSUBSCRIBED, BOUNCED_PERMANENT,COMPLAINED"
}
]
}