List accounts

GET /api/v2/accounts Returns all accounts the authenticated user has active membership on. Use it to populate an account switcher or to discover the id you pass to admin operations.

Request

curl

curl https://api.interchange.io/api/v2/accounts \
  -H "Authorization: Bearer $SCOPE3_API_KEY"

Parameters

None.

Response

{
  "accounts": [
    {
      "id": 100,
      "company": "Acme Inc",
      "name": "Acme",
      "role": "ADMIN"
    },
    {
      "id": 205,
      "company": "Acme Retail",
      "name": "Acme Retail",
      "role": "MEMBER"
    }
  ]
}

Field	Type	Notes
`accounts`	array	Accounts the user has access to
`accounts[].id`	integer	Account ID
`accounts[].company`	string	Company name
`accounts[].name`	string	Display name
`accounts[].role`	string	User role on this account (`MEMBER`, `ADMIN`, `SUPER_ADMIN`)

Errors

401 UNAUTHORIZED — missing or invalid bearer token.

See Errors for the full error contract.

Account tasks

All account operations

Get current account

Your current context

Create account

Add an account under your organization

Get notification preferences Update account domain

⌘I

Getting Started

Advertisers

Campaigns

Product Discovery

Webhooks

Creatives

Signals & Brand

Audiences & Inventory

Measurement & Conversions

Reporting & Activity

Planning & Governance

Connections

Account & Billing

Request

Parameters

Response

Errors

Account tasks

Get current account

Create account

​Request

​Parameters

​Response

​Errors

​Related

Account tasks

Get current account

Create account

Request

Parameters

Response

Errors

Related