Skip to main content
The Partner API allows CookieChimp partners to programmatically manage their groups (workspaces) and accounts. Partner API tokens have access to resources across all groups belonging to that partner.

Authentication

Partner endpoints require a partner API token passed in the Authorization header:
Authorization: Bearer YOUR_PARTNER_API_TOKEN
Partner API tokens are issued by CookieChimp and are associated with a specific Partner record. To request a partner API token, contact support@cookiechimp.com.
Partner API tokens are different from user or account tokens. Endpoints that require a partner token (such as creating or updating groups) will return a 401 error if a user or account token is used instead.

Token Types

CookieChimp API tokens can belong to three different bearer types:
Token TypeAccess ScopeUse Case
PartnerAll groups and accounts under the partnerAutomated provisioning, bulk management
UserAccounts the user is a member ofEnd-user integrations
AccountSingle account onlyWidget and account-scoped operations

Available Endpoints

Groups (Partner token required)

Groups are workspaces that contain one or more accounts. Partners use groups to organize their customers.

Accounts (Partner, User, or Account token)

Accounts represent individual websites managed by CookieChimp. With a partner token, you get access to all accounts across your groups.

Account Onboarding Status

When listing accounts, you can filter by onboarding_status to track provisioning progress:
StatusDescription
account_createdAccount has been created but no vendors configured
vendors_setupCategories, services, or TCF vendors have been configured
code_installedThe consent banner script has been installed on the website
inactiveFewer than 10 visitors in the last 30 days
liveAccount is live and operational
curl -X GET "https://cookiechimp.com/api/v1/accounts?onboarding_status=live" \
  -H "Authorization: Bearer YOUR_PARTNER_API_TOKEN"