Skip to main content
GET
Get Retailers

Partner app access

Partner apps can call this endpoint on behalf of the authorizing brand with an OAuth access token containing retailers:read. No API key is required.
  • include=enabled (default) returns retailers configured for the authorizing brand.
  • include=all returns all active retailers. Each retailer’s enabled and link_url values reflect only that brand’s configuration; disabled retailers have a null link_url.
A token without retailers:read receives 403 insufficient_scope. For older installations, follow the reauthorization steps.
Retailer link_url values are static URLs that are deprecated and will be removed in a future release. Use customer Link tokens instead. Existing URLs continue to work for now.

Headers

authorization
string | null
x-api-key
string | null

Query Parameters

include
enum<string>
default:enabled

enabled (default) — only the retailers enabled for the client; all — every active retailer.

Available options:
enabled,
all

Response

Successful Response

retailers
RetailerListItem · object[]