Skip to content

Get marketing consents

Request

Get all marketing consents collected through Understory checkouts.

Security
OAuth2(Required scopes: marketing.read)
Query
cursorstring

Pagination cursor for fetching the next page of results. Omit or pass an empty string to start from the beginning of the list.

limitinteger, (int32), [ 1 .. 100 ]

Maximum number of items to return per page. Defaults to 100, maximum 100.

Default:100
curl -i -X GET \
  'https://api.understory.io/v1/marketing-consents?cursor=string&limit=100' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json
itemsArray of objects(MarketingConsent)required

The list of marketing consents.

nextstring

Cursor for the next page of results. An empty string or absent value indicates the end of the list.

Response
{ "next": "string", "items": [ { … } ] }