Get group member(s)

get

https://{custom_host}/v1/groups/{groupId}/members

Queries a given group for consent records, optionally specifying an individual consumer. Response may be returned as JSON or CSV format. Note- Replace {custom_host} in the URL with your hostname to try this API with your environment. See Know your endpoint page.

Path Params

groupId

string

required

Unique ID of group

Query Params

channel

string

enum

If specified, will only return consent definitions for consumers on a particular channel

Allowed:

address

string

If specified, will return consent definitions for all channels containing a single consumer address if found.

consent

boolean

If specified, filters results by the consumer's opted in/out status

format

string

enum

Defaults to JSON

Response content-type.

Allowed:

continuationToken

string

The continuation token returned in a previouse request that specifies the next page of results to retrieve.

pageSize

integer

≤ 1000

Defaults to 50

The amount of results to return with the next page.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

404

Invalid or unknown group ID.

Language

Credentials

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

text/csv

200Consent definition object(s) indicating either positive or negative consent. If there are no consumers, an empty list will be returned.