Get group member(s)
GET https://{{contactPolicyBaseURL}}/v1/groups/:groupId/members?channel=<string>&address=<string>&consent=<boolean>&format=JSON&pageSize=50
Queries a given group for consent records, optionally specifying an individual consumer. Response may be returned as JSON or CSV format.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
channel | string | If specified, will only return consent definitions for consumers on a particular channel | |
address | string | If specified, will return consent definitions for all channels containing a single consumer address if found. | |
consent | string | If specified, filters results by the consumer's opted in/out status | |
format | string | Response content-type. | |
pageSize | number | The amount of results to return with the next page. Maximum allowed value is 1000. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Authorization | string | ||
Accept | string |
RESPONSES
status: OK
[{"address":"\u003cstring\u003e","channel":"\u003cstring\u003e","consent":"\u003cboolean\u003e","lastUpdated":"\u003cstring\u003e","reason":"\u003cstring\u003e","expires":"\u003cstring\u003e","metadata":[{"keyword":"\u003cstring\u003e","campaign":"\u003cstring\u003e","source":"\u003cstring\u003e","messageBody":"\u003cstring\u003e"},{"keyword":"\u003cstring\u003e","campaign":"\u003cstring\u003e","source":"\u003cstring\u003e","messageBody":"\u003cstring\u003e"},{"keyword":"\u003cstring\u003e","campaign":"\u003cstring\u003e","source":"\u003cstring\u003e","messageBody":"\u003cstring\u003e"},{"keyword":"\u003cstring\u003e","campaign":"\u003cstring\u003e","source":"\u003cstring\u003e","messageBody":"\u003cstring\u003e"},{"keyword":"\u003cstring\u003e","campaign":"\u003cstring\u003e","source":"\u003cstring\u003e","messageBody":"\u003cstring\u003e"},{"keyword":"\u003cstring\u003e","campaign":"\u003cstring\u003e","source":"\u003cstring\u003e","messageBody":"\u003cstring\u003e"},{"keyword":"\u003cstring\u003e","campaign":"\u003cstring\u003e","source":"\u003cstring\u003e","messageBody":"\u003cstring\u003e"},{"keyword":"\u003cstring\u003e","campaign":"\u003cstring\u003e","source":"\u003cstring\u003e","messageBody":"\u003cstring\u003e"},{"keyword":"\u003cstring\u003e","campaign":"\u003cstring\u003e","source":"\u003cstring\u003e","messageBody":"\u003cstring\u003e"},{"keyword":"\u003cstring\u003e","campaign":"\u003cstring\u003e","source":"\u003cstring\u003e","messageBody":"\u003cstring\u003e"}]},{"address":"\u003cstring\u003e","channel":"\u003cstring\u003e","consent":"\u003cboolean\u003e","lastUpdated":"\u003cstring\u003e","reason":"\u003cstring\u003e","expires":"\u003cstring\u003e","metadata":[{"keyword":"\u003cstring\u003e","campaign":"\u003cstring\u003e","source":"\u003cstring\u003e","messageBody":"\u003cstring\u003e"},{"keyword":"\u003cstring\u003e","campaign":"\u003cstring\u003e","source":"\u003cstring\u003e","messageBody":"\u003cstring\u003e"},{"keyword":"\u003cstring\u003e","campaign":"\u003cstring\u003e","source":"\u003cstring\u003e","messageBody":"\u003cstring\u003e"},{"keyword":"\u003cstring\u003e","campaign":"\u003cstring\u003e","source":"\u003cstring\u003e","messageBody":"\u003cstring\u003e"},{"keyword":"\u003cstring\u003e","campaign":"\u003cstring\u003e","source":"\u003cstring\u003e","messageBody":"\u003cstring\u003e"},{"keyword":"\u003cstring\u003e","campaign":"\u003cstring\u003e","source":"\u003cstring\u003e","messageBody":"\u003cstring\u003e"},{"keyword":"\u003cstring\u003e","campaign":"\u003cstring\u003e","source":"\u003cstring\u003e","messageBody":"\u003cstring\u003e"},{"keyword":"\u003cstring\u003e","campaign":"\u003cstring\u003e","source":"\u003cstring\u003e","messageBody":"\u003cstring\u003e"},{"keyword":"\u003cstring\u003e","campaign":"\u003cstring\u003e","source":"\u003cstring\u003e","messageBody":"\u003cstring\u003e"},{"keyword":"\u003cstring\u003e","campaign":"\u003cstring\u003e","source":"\u003cstring\u003e","messageBody":"\u003cstring\u003e"}]}]