Accounts and connections
Start here. GET /v1/me reports which scopes and accounts your key reaches, and is the cheapest way to check that a key works.
Servers
me
Describes the authenticated API key: its scopes and accessible accounts. No scope required — any valid key can call it.
Describe the authenticated credential (API key or OAuth grant): scopes and accessible accounts
Authorizations
Client API key (POST /api-keys). Send as Authorization: Bearer epk_live_....
Responses
200
accounts
Accounts this API key can operate on, selectable via the Epinium-Account header. Requires connections:read.
Operations
List the accounts this API key can operate on
Authorizations
Client API key (POST /api-keys). Send as Authorization: Bearer epk_live_....
Responses
200
List the authenticated account's connections
Authorizations
Client API key (POST /api-keys). Send as Authorization: Bearer epk_live_....
Parameters
Query Parameters
Page size. The default is enough to explore; raise it only when you need to walk a whole collection.
20201100Cursor for the next page: the id of the last record you received. Returns the records after it.
Cursor for the previous page: the id of the first record you received. Returns the records before it.
Inline related records instead of returning just their ids. Repeat the param for several (expand[]=connection&expand[]=country) and nest with dot notation (connection.country), up to 4 levels.
Trim the response to the fields you need, comma-separated and keyed by ENTITY TYPE rather than by resource name: fields[campaign]=id,name. A key that matches no entity is ignored silently and the full object comes back.
Case-insensitive substring match over the connection name. Use it to find a record by name when you do not have its id, instead of paging through the whole list. Regex metacharacters are matched literally.
1200Set to true to also receive total_count: how many records match every filter of this request, ignoring starting_after/ending_before/offset - the size of the whole result set, not of what is left. has_more is always returned regardless. It costs an extra count query, so ask for it once, on the first page, to decide whether the set is worth walking. On metrics resources it counts entities (or groups with group_by), and, with any granularity other than total, each of their periods that has data, not entities times periods: entity-days with granularity=daily. total_count comes back null when the count could not finish in time; the list is still returned, so treat it as unknown, never as zero.
"true""false""seller""vendor""adv-profile""shopify""woocommerce"Responses
200
GET /v1/connections/{id}
Authorizations
Client API key (POST /api-keys). Send as Authorization: Bearer epk_live_....
Parameters
Path Parameters
24-character hexadecimal Mongo ObjectId.
"^[a-f0-9]{24}$"Query Parameters
Inline related records instead of returning just their ids. Repeat the param for several (expand[]=connection&expand[]=country) and nest with dot notation (connection.country), up to 4 levels.
Trim the response to the fields you need, comma-separated and keyed by ENTITY TYPE rather than by resource name: fields[campaign]=id,name. A key that matches no entity is ignored silently and the full object comes back.
Responses
200