Skip to main content
GET
List accounts

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. The effective range is 1–50; any value outside it is accepted but falls back to the default of 20.

page
integer
default:1

Page number. Must be a positive integer; anything else returns a 400. Requesting a page past the end returns the last page.

Required range: x >= 1
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
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

List of accounts

pagination
object
Example:
data
object[]