Skip to main content

Get Ad Account

GET 

/api/advertising/accounts/:adAccount

Returns one ad account. Also returns merge_candidate_ids: other ad accounts for the same platform account id on a different connection (typically left behind after reconnecting with a new connection), which can be folded into this one with Merge Ad Accounts.

Required scope: advertising:read

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Requires the advertising.view permission. Token scope: advertising:read (personal access and OAuth tokens).

Each ad account carries: id, integration_instance_id / integration_instance_name (the connection it came from), platform / platform_label, external_account_id (the platform's own id), name, name_override, display_name (override when set, else name), marketplace_code, currency_code, timezone, sales_channel_id / sales_channel_name (the sales channel whose orders and stock its ads draw on), linked_catalog_id, is_selected, automation_mode (off, monitor, suggest, auto), cost_entry_creation_enabled, unmapped_spend_to_channel, kill_switch_on, status (active, needs_reauth, disabled), access_level (not_connected, awaiting_approval, reporting_only, full), can_write, capabilities, last_structure_synced_at, last_performance_synced_at, needs_sales_channel (selected but not yet mapped to a sales channel), created_at, updated_at.

Request​

Responses​

OK

Response Headers
    Content-Type