Skip to main content
GET /api/v2/accounts Returns every customer account you can switch into. Use it to discover child accounts under your org or to find the customer ID for a subsequent domain or membership operation.

​
Request

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

​
Parameters

None. Accounts are scoped to the authenticated user’s memberships.

​
Response

{
  "accounts": [
    {
      "id": 100,
      "company": "Northwind Media",
      "name": "Northwind",
      "role": "ADMIN"
    },
    {
      "id": 200,
      "company": "Northwind Retail",
      "name": "Retail",
      "role": "MEMBER"
    }
  ]
}
FieldTypeNotes
accounts[]arrayOne entry per account you have access to
accounts[].idintegerCustomer ID
accounts[].companystringCompany name
accounts[].namestringDisplay name
accounts[].rolestringYour role on this customer (MEMBER, ADMIN, SUPER_ADMIN). May be omitted

​
Errors

  • 401 UNAUTHORIZED — missing or invalid API key.
See Errors for the full error contract.

Account tasks

All account operations

Get current account

The account you are operating as

Create child account

Provision a new child