Skip to main content
GET
/
consents
List consents
curl --request GET \
  --url https://cookiechimp.com/api/v1/consents \
  --header 'Authorization: Bearer <token>'
{
  "pagination": {
    "prev_url": "/api/v1/consents?page=",
    "next_url": "/api/v1/consents?page=2",
    "count": 4,
    "page": 1,
    "prev": null,
    "next": 2
  },
  "data": [
    {
      "id": "consent321",
      "session_id": "sess123",
      "user_id": "user456",
      "user_preferences": {
        "accept_type": "all",
        "accepted_categories": [
          "cat1",
          "cat2"
        ],
        "rejected_categories": [
          "cat3",
          "cat4"
        ],
        "accepted_services": {
          "company1": [
            "cookie1",
            "cookie2"
          ]
        },
        "rejected_services": {}
      },
      "created_at": "2023-01-20T12:46:30Z"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

API token obtained from the login endpoint or the dashboard

Query Parameters

​
limit
integer
default:20

Number of resources to return

Required range: 1 <= x <= 100
​
offset
integer
default:0

Number of resources to skip

Required range: x >= 0
​
sort
string

Field to sort by

​
order
enum<string>

Sort order

Available options:
asc,
desc
​
session_id
string

ID of the session to filter by

​
user_id
string

ID of the user to filter by

Response

List of consents

​
pagination
object
Example:
{
  "prev_url": "/api/v1/consents?page=",
  "next_url": "/api/v1/consents?page=2",
  "count": 4,
  "page": 1,
  "prev": null,
  "next": 2
}
​
data
object[]