Skip to main content
GET
/
accounts
List accounts
curl --request GET \
  --url https://cookiechimp.com/api/v1/accounts \
  --header 'Authorization: Bearer <token>'
{
  "pagination": {
    "prev_url": "/api/v1/accounts?page=",
    "next_url": "/api/v1/accounts?page=2",
    "count": 4,
    "page": 1,
    "prev": null,
    "next": 2
  },
  "data": [
    {
      "id": "abc123",
      "name": "example.com",
      "allowed_domains": [
        "example.net",
        "example.org"
      ],
      "owner_id": "xyz123",
      "onboarding_status": "live",
      "visitor_stats": {
        "comparison": "vs. Last 30 days",
        "statistics": {
          "views": {
            "count": 1471,
            "rate_of_change": 3.37
          },
          "consents": {
            "count": 213,
            "rate_of_change": 25.29
          },
          "unique_visitors": {
            "count": 895,
            "rate_of_change": 42.06
          }
        },
        "raw_data": {
          "views": {
            "current_period": 1471,
            "previous_period": 1423
          },
          "consents": {
            "current_period": 213,
            "previous_period": 170
          },
          "unique_visitors": {
            "current_period": 895,
            "previous_period": 630
          }
        }
      },
      "created_at": "2022-12-20T18:45:00Z",
      "updated_at": "2023-01-10T19:00:00Z"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

API token obtained from the login endpoint or the dashboard

Query Parameters

​
per_page
integer
default:20

Number of records to return per page

Required range: 1 <= x <= 50
​
page
integer
default:1

Page number

​
onboarding_status
enum<string>

The status of the account, where:

  • account_created: The account has been created.
  • vendors_setup: Categories, services or TCF vendors have been set up.
  • code_installed: The script has been installed on the user's website.
  • inactive: Less than 10 visitors to the user's website in the last 30 days.
  • live: The account is live and operational.
Available options:
account_created,
vendors_setup,
code_installed,
inactive,
live

Response

200 - application/json

List of accounts

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