Skip to main content
GET
Get account

Authorizations

Authorization
string
header
required

API token obtained from the login endpoint or the dashboard

Path Parameters

id
string
required

ID of the resource

Query Parameters

visitor_stats
boolean
default:true

Set to false to skip resolving analytics and return visitor_stats as null. Useful when you only need the account list, as it avoids the analytics lookup entirely.

Response

Account

id
string
read-only

Unique identifier for the account

name
string
read-only

Domain of the account

allowed_domains
string[]
read-only

List of allowed domains the script will run on

owner_id
string
read-only

ID of the account user that owns the account

onboarding_status
string
read-only

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.
visitor_stats
object | null

Visitor analytics for the last 30 days, compared against the 30 days before that. null when the client passed ?visitor_stats=false.

created_at
string<date-time>
read-only

Date and time when the account was created

updated_at
string<date-time>
read-only

Date and time when the account was last updated