Consents
List consents
Consents
List consents
List all consents
GET
/
consents
X-API-KEY
string
*
X-API-KEY
Required
string
limit
integer
limit
integer
Number of resources to return
offset
integer
offset
integer
Number of resources to skip
sort
string
sort
string
Field to sort by
order
enum<string>
order
enum<string>
Sort order
session_id
string
session_id
string
ID of the session to filter by
user_id
string
user_id
string
ID of the user to filter by
curl --request GET \
--url https://cookiechimp.com/api/v1/consents \
--header 'X-API-KEY: <api-key>'{
"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"
}
],
"pagination": {
"total": 100,
"limit": 20,
"offset": 0
}
}Authorizations
X-API-KEY
string
headerrequiredQuery Parameters
limit
integer
default: 20Number of resources to return
offset
integer
default: 0Number of resources to skip
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
200 - application/json
data
object[]
data.user_id
string
ID of the user set by your website
data.user_preferences
object
requireddata.user_preferences.accept_type
enum<string>
Available options:
all, custom, necessary data.user_preferences.accepted_categories
string[]
data.user_preferences.rejected_categories
string[]
data.user_preferences.accepted_services
object
data.user_preferences.rejected_services
object
data.id
string
Unique identifier for the consent
data.session_id
string
ID of the session
data.created_at
string
Date and time when the consent was created
pagination
object
pagination.total
integer
Total number of resources
pagination.limit
integer
Number of resources to return
pagination.offset
integer
Number of resources to skip
curl --request GET \
--url https://cookiechimp.com/api/v1/consents \
--header 'X-API-KEY: <api-key>'{
"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"
}
],
"pagination": {
"total": 100,
"limit": 20,
"offset": 0
}
}