Skip to main content
GET /api/v2/storefront/join-links Returns the active join links owned by your organization, across all of your storefronts. Disabled (revoked) links are not included.

​
Request

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

​
Parameters

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

​
Response

200 OK with a JoinLinkList: 
{
  "items": [
    {
      "id": "5571",
      "slug": "northwind-advertisers",
      "joinPath": "/join/northwind-advertisers",
      "sellerCustomerId": 318,
      "storefrontId": 4012,
      "role": "BUYER",
      "posture": "prepay",
      "approvalPolicy": "manual_approve",
      "active": true,
      "uses": 12,
      "maxUses": 250,
      "expiresAt": "2026-12-31T23:59:59.000Z",
      "revokedAt": null,
      "createdAt": "2026-06-14T18:22:10.441Z",
      "updatedAt": "2026-06-14T18:22:10.441Z"
    }
  ],
  "total": 1
}

​
Errors

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

Join-link tasks

All operations

Create join link

Mint a new link

Disable join link

Soft-revoke a link

Errors

Shared error contract