subscribers
List subscribers
Returns a list of subscribers in a paginated manner. Each object in the collection represents a Subscriber. This endpoint should always return a result even if there are zero subscribers in the collection.
get/subscribers
Query parameters
per_pageinteger
Number of objects to be returned, per page.
ending_beforestring
ending_before is the ID of the object that should be included in order to fetch the previous page of the list, which ends before this object's place in the collection.
starting_afterstring
starting_after is the ID of the object that should be included in order to fetch the next page of the list, which begins after this object's place in the collection.
scopesobject
Scopes can be used to search through and filter a collection of results.
Response
OK
Example response
{
"per_page": 15,
"total": 100,
"collection": [
{
"id": 111,
"name": "John Doe",
"email": "john@example.com"
}
]
}