Skip to content

Getting consent lists  

You can download a complete list of consents to communication granted by your customers. Settings > Consents > Consents

You can read more about it here: Customer consents

GET method 

The GET method is used to obtain a list of all current consents along with their properties. 

Your GET query must contain: 

  1. Server address (endpoint): 
  1. API key: your API key, found in Settings > API. 

A valid API query for consent list looks like this:

What data will be included in the response? 

The response to a correctly submitted query contains the following data: 

Parameter Type Description 
id Integer($int32) Consent list’s identification number visible under Settings > Consents > Consents. 
name string Consent list’s name assigned by you in Settings > Consents > Consents. 
type string Consent type with its properties: General, Email, Sms. 

Query response codes  

200: Success 

The query has been processed and the server has returned a response. Sample response syntax looks as follows: 

  "status": 0,
  "data": [
      "id": 0,
      "name": "string",
      "type": "string"

401: Unauthorized 

The request was missing an API key or you are requesting access to information that you do not have permission to access. Sample response syntax looks as follows: 

  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
On this page
To top