Skip to main content
GET
/
advertisers
/
{advertiserId}
/
accounts
/
available
List available accounts
curl --request GET \
  --url https://api.interchange.io/api/v2/buyer/advertisers/{advertiserId}/accounts/available \
  --header 'Authorization: Bearer <token>'
{
  "accounts": [
    {
      "accountId": "acc_acme_pinnacle",
      "sources": [
        {
          "storefrontId": 0,
          "storefrontName": "<string>",
          "sourceId": "<string>",
          "sourceName": "<string>"
        }
      ],
      "status": "active",
      "name": "Acme c/o Pinnacle",
      "advertiser": "Acme Corp",
      "billingProxy": "Pinnacle Media",
      "house": "acme-corp.com",
      "billing": "advertiser"
    }
  ],
  "total": 8,
  "synced": true,
  "billingOptions": {
    "default": "<string>",
    "supported": [
      "<string>"
    ]
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.interchange.io/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

API key or access token

Path Parameters

​
advertiserId
string
required

Unique identifier for the advertiser

Minimum string length: 1
Example:

"12345"

Query Parameters

​
storefrontId
integer
required

Storefront the source lives on. Pair with sourceId to identify the source whose accounts to list.

Required range: x <= 9007199254740991
Example:

42

​
sourceId
string
required

Inventory source within storefrontId whose accounts to list.

Minimum string length: 1
Example:

"src_main"

​
refresh
enum<string>

When true, re-fetches accounts from the source before returning results. Defaults to false (returns cached accounts).

Available options:
true,
false
Example:

"false"

​
billingType
string

Billing arrangement type to filter accounts by (e.g. "advertiser", "operator", "agent"). Must be one of the values supported by this source. Defaults to the source's default billing type if omitted.

Example:

"advertiser"

​
credentialId
string

ID of a specific registered credential to use for account discovery. Required when the customer has multiple credentials registered for this source. Use GET /storefronts/credentials to list registered credentials and their IDs.

Example:

"42"

​
take
integer
default:50

Number of results to return (max 250)

Required range: x <= 250
Example:

50

​
skip
integer
default:0

Number of results to skip for pagination

Required range: 0 <= x <= 9007199254740991
Example:

0

Response

List available accounts

Response containing a list of available accounts from a partner

​
accounts
object[]
required

List of available (discovered) accounts

​
total
integer
required

Total count of available accounts

Required range: 0 <= x <= 9007199254740991
Example:

8

​
synced
boolean

True when no accounts matched and a sync_accounts call was automatically triggered to provision this account at the partner. The list reflects the post-sync state.

​
billingOptions
object

Billing options supported by this partner agent, as reported in its ADCP capabilities.