Sign in
Groups

List subscribers

Get subscribers belonging to a group.

get/1/newsletters/{domain}/groups/{group}/subscribers

Path parameters

domaininteger required

Unique identifier of the Domain

groupinteger required

Unique identifier of the Group

Query parameters

withstring

Optional : Allows loading additional data about a resource, which may include related resources.

searchstring

Filter groups

status'active' | 'bounced' | 'junk' | 'unconfirmed' | 'under_verification' | 'unsubscribed'

Status of the resource {name}

group_idinteger
return'total'

Optional : If you pass this parameter with the value total, then the response will be the number of items in the collection, instead of the items themselves.<br /> Part of the total capacity

limitinteger

Optional parameter that define the number of items to return<br /> Part of the offset capacity

skipinteger

Optional parameter that define the index of the first item to return (0 = first item)<br /> Part of the offset capacity

pageinteger

Optional parameter that define the page number<br /> Part of the pagination capacity

per_pageinteger

Optional parameter that define the number of items per page<br /> Part of the pagination capacity

string
OR
string[]

Optional parameter that define the field used for sorting<br /> Part of the sort capacity

order'asc' | 'desc'

Optional parameter that define the default sort order<br /> Part of the sort capacity

order_forobject

Optional parameter that define the sorting order for a field<br /> By default order is used<br /> Part of the sort capacity

Response

OK

result'success' | 'error' | 'asynchronous' required

Result of the HTTP request

totalinteger

Total number of items Added when using query parameter page

pageinteger

Number of the current page Added when using query parameter page

pagesinteger

Total number of pages Added when using query parameter page

items_per_pageinteger

Number of items per page Added when using query parameter page

Example response

{
  "result": "success",
  "total": 221,
  "page": 2,
  "pages": 15,
  "items_per_page": 15
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.