Skip to main content
GET
List external account mappings

Authorizations

Authorization
string
header
required

API key or access token

Query Parameters

Optional search over provider, connection, external account name, and external account ID.

provider
string

Optional provider type filter, such as google or meta.

advertiserId
string

Optional mapped advertiser ID filter.

Pattern: ^\d+$
storefrontId
string

Optional storefront ID filter for embedded connection views.

Pattern: ^\d+$
mappingStatus
enum<string>
default:all

Filter by mapping state. 'unreachable' returns only preserved mappings whose platform account no active connection reaches (relink to restore).

Available options:
all,
mapped,
unmapped,
unreachable
limit
integer
default:50
Required range: 1 <= x <= 100
offset
integer
default:0
Required range: 0 <= x <= 9007199254740991

Response

List external account mappings

Paginated external account mapping table for buyer integrations.

items
object[]
required
total
integer
required
Required range: 0 <= x <= 9007199254740991
hasMore
boolean
required
nextOffset
integer | null
required
Required range: 0 <= x <= 9007199254740991