Skip to main content
GET /api/v2/buyer/advertisers/{advertiserId}/accounts/available Lists accounts a source has discovered but not yet linked to the advertiser. Call this before linking an account to pre-fill accountId and check the source’s supported billingOptions.

​
Request

curl
curl "https://api.interchange.io/api/v2/buyer/advertisers/12345/accounts/available?storefrontId=42&sourceId=src_main&take=50" \
  -H "Authorization: Bearer $SCOPE3_API_KEY"

​
Parameters

FieldTypeRequiredNotes
advertiserIdstring (path)YesUnique identifier for the advertiser
storefrontIdinteger (query)YesStorefront the source lives on
sourceIdstring (query)YesInventory source within storefrontId
refreshenum (query)Notrue re-fetches from the source; false (default) returns cached accounts
billingTypestring (query)NoFilter by billing type. Must be a value the source supports. Defaults to the source’s default
credentialIdstring (query)NoSpecific registered credential to use. Required when multiple credentials exist for the source
takeinteger (query)NoResults to return. Default 50, max 250
skipinteger (query)NoResults to skip for pagination. Default 0

​
Response

{
  "accounts": [
    {
      "accountId": "acc_acme_pinnacle",
      "credentialId": "cred_snap_coke",
      "name": "Acme c/o Pinnacle",
      "advertiser": "Acme Corp",
      "billingProxy": "Pinnacle Media",
      "house": "acme-corp.com",
      "billing": "advertiser",
      "sources": [
        { "storefrontId": 42, "storefrontName": "Example Storefront", "sourceId": "src_main", "sourceName": "Main Source" }
      ],
      "status": "active"
    }
  ],
  "total": 8,
  "synced": false,
  "billingOptions": { "default": "advertiser", "supported": ["advertiser", "agent"] }
}
account.status is one of active, pending_approval, payment_required, suspended, closed. credentialId identifies the connected provider credential that owns the account. Include it when linking the account if the buyer has connected more than one credential for the same adapter storefront and duplicate account IDs may exist. synced is true when no accounts matched and a sync_accounts call was triggered to provision one at the partner. Always check billingOptions.supported before sending a billingType.

​
Errors

  • 400 VALIDATION_ERROR — missing storefrontId/sourceId, or multiple credentials exist and credentialId was not provided.
  • 404 NOT_FOUND — advertiserId or source does not exist or is not visible.
See Errors for the full error contract.

Advertiser tasks

All advertiser operations

Advertiser overview

Linked accounts model

Create advertiser

Link accounts at creation

Update reporting bucket

Configure offline delivery on a link