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.Documentation Index
Fetch the complete documentation index at: https://docs.cookiechimp.com/docs/llms.txt
Use this file to discover all available pages before exploring further.
Authentication
Partner endpoints require a partner API token passed in theAuthorization header:
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 Type | Access Scope | Use Case |
|---|---|---|
| Partner | All groups and accounts under the partner | Automated provisioning, bulk management |
| User | Accounts the user is a member of | End-user integrations |
| Account | Single account only | Widget 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.- List Groups — List all groups for your partner
- Get Group — Get a specific group by ID
- Create Group — Create a new group
- Update Group — Update a group’s name or external ID
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.- List Accounts — List all accounts (supports
onboarding_statusfilter) - Get Account — Get a specific account by ID
Account Onboarding Status
When listing accounts, you can filter byonboarding_status to track provisioning progress:
| Status | Description |
|---|---|
account_created | Account has been created but no vendors configured |
vendors_setup | Categories, services, or TCF vendors have been configured |
code_installed | The consent banner script has been installed on the website |
inactive | Fewer than 10 visitors in the last 30 days |
live | Account is live and operational |