Skip to main content

List audience members

Get list of members of an audience.

URL: https://api.courier.com/audiences/:audience_id/members

Method: GET

Path Parameters

audience_idstringrequired
A unique identifier representing the audience_id

Query Parameters

cursorstring
A unique identifier that allows for fetching the next set of audiences

Responses

status: 200 Audience members associated with the audience by `audience_id`

itemsarray
List of audience members
+ Show Properties
pagingobject
Pagination information
+ Show Properties

status: 400 Bad Request

messagestring
A message describing the error that occurred.
typestring
[invalid_request_error] The type of error that occurred.

Request Example

curl --request GET \
--url https://api.courier.com/audiences/developer-audience/members?cursor=MTU4OTQ5NTI1ODY4NywxLTVlYmRjNWRhLTEwODZlYWFjMWRmMjEwMTNjM2I0ZjVhMA \
--header 'Accept: application/json'

Responses Example

{
"items": [
{
"member_id": "suhas_deshpande",
"added_at": "2020-01-01T00:00:00.000Z",
"audience_id": "developer-audience",
"audience_version": 1,
"reason": "\"EQ('title', 'Software Engineer') => true\""
}
],
"paging": {
"cursor": "randomcursor",
"more": true
}
}
{
"message": "filteroperator should be equal to one of the allowed values AND, EQ, GT, GTE, INCLUDES, LT, LTE, NEQ, OMIT, OR",
"type": "invalid_request_error"
}

Example

Method: GET

URL: https://api.courier.com/audiences/abcdefgh12345678/members