Skip to main content
GET /api/v2/storefront/sponsored-buyers Returns the sponsored buyers your organization owns — the advertisers that joined through your join links — with each buyer’s status, posture, and resolved name.

Request

curl https://api.interchange.io/api/v2/storefront/sponsored-buyers \
  -H "Authorization: Bearer $SCOPE3_API_KEY"

Parameters

None. The result is scoped to your seller customer context.

Response

200 OK with a SponsoredBuyerList:
{
  "items": [
    {
      "buyerCustomerId": 90412,
      "buyerName": "Lakeside Motors",
      "storefrontId": 4012,
      "status": "pending",
      "posture": "prepay",
      "createdAt": "2026-06-14T18:40:02.118Z"
    },
    {
      "buyerCustomerId": 90377,
      "buyerName": "Corner Slice",
      "storefrontId": 4012,
      "status": "active",
      "posture": "prepay",
      "createdAt": "2026-06-12T09:15:44.901Z"
    }
  ],
  "total": 2
}

Response fields

FieldTypeNotes
buyerCustomerIdintegerThe buyer’s customer id. Use it in the approve / suspend / reactivate paths.
buyerNamestring | nullBuyer’s company/display name from the core customer record; null if not resolvable.
storefrontIdintegerThe storefront the buyer is scoped to.
statusenumpending, active, or suspended. See the status lifecycle.
postureenumprepay or credit.
createdAtstringISO-8601 timestamp of when the buyer joined.

Errors

  • 401 UNAUTHORIZED — missing or invalid API key.
  • 403 CUSTOMER_ROLE_DENIED — the API key is not a seller account; only sellers manage sponsored buyers.
See Errors for the full error contract.

Sponsored-buyer tasks

All operations

Approve sponsored buyer

Admit a pending buyer

Suspend sponsored buyer

Pause an active buyer

Errors

Shared error contract