Skip to main content
GET
/
storefronts
List storefronts
curl --request GET \
  --url https://api.interchange.io/api/v2/buyer/storefronts \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "id": 0,
      "platformId": "<string>",
      "name": "<string>",
      "publisherDomain": "<string>",
      "status": "PENDING",
      "sourceCount": 5,
      "connectedSourceCount": 3
    }
  ],
  "total": 4503599627370495,
  "hasMore": true,
  "nextOffset": 4503599627370495
}

Documentation Index

Fetch the complete documentation index at: https://docs.interchange.io/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

API key or access token

Query Parameters

​
name
string

Filter by storefront name (partial match, case-insensitive)

​
visibility
enum<string>

Which storefronts to list. public (default) returns ACTIVE storefronts available to any buyer. private returns ALL storefronts (ACTIVE, PENDING, and DISABLED) owned by customers in the caller's parent organization.

Available options:
public,
private
​
limit
integer

Maximum storefronts per page (default: 20, max: 50)

Required range: x <= 50
​
offset
integer

Number of storefronts to skip for pagination (default: 0)

Required range: 0 <= x <= 9007199254740991

Response

List storefronts

Paginated list of storefront summaries available to a buyer

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