Get join context

GET /api/v2/storefront/join-context/{slug} Resolves a join-link slug to brand-safe context so the co-branded /join/{slug} signup page can theme itself before the prospective buyer has an account. This endpoint is public and unauthenticated — it never requires or accepts an API key, and it never returns seller or account identifiers. It surfaces only what a public signup screen needs to render: storefront name, operator domain, logo, brand colors, and locale hints.

This is the only join-link endpoint that is unauthenticated. Minting, listing, and disabling links all require a seller API key.

Request

curl https://api.interchange.io/api/v2/storefront/join-context/northwind-advertisers

Parameters

Field	Type	Required	Notes
`slug`	string (path)	Yes	The join-link slug (2–64 chars, lowercase letters, numbers, hyphens).

Response

200 OK with a JoinLinkContext. A usable link returns valid: true with branding populated:

{
  "slug": "northwind-advertisers",
  "valid": true,
  "storefrontName": "Northwind Media",
  "operatorDomain": "northwind.example.com",
  "logoUrl": "https://logos.interchange.io/northwind.png",
  "brandColors": {
    "primary": "#E4002B",
    "secondary": "#1A1A1A"
  },
  "defaultCurrency": "EUR",
  "supportedLanguages": ["nl", "en"]
}

A missing, revoked, expired, exhausted, or closed link returns valid: false with all branding fields null — never an error status:

{
  "slug": "northwind-advertisers",
  "valid": false,
  "storefrontName": null,
  "operatorDomain": null,
  "logoUrl": null,
  "brandColors": null,
  "defaultCurrency": null,
  "supportedLanguages": null
}

Response fields

Field	Type	Notes
`slug`	string	Echoes the requested slug.
`valid`	boolean	`false` for a missing, revoked, expired, exhausted, or closed link.
`storefrontName`	string \| null	Display name for the signup header. Null when invalid.
`operatorDomain`	string \| null	The operator’s domain. Null when invalid.
`logoUrl`	string \| null	Brand logo (http(s)). Null when invalid or unresolved.
`brandColors`	object \| null	brand.json colors (`primary`, `secondary`, `accent`, …). Null when unresolved.
`defaultCurrency`	string \| null	Seller-confirmed settlement currency (ISO-4217). Null until the seller confirms it.
`supportedLanguages`	string[] \| null	Seller-curated languages the join surface may localize within. Null if unset.

Errors

400 VALIDATION_ERROR — slug does not match the allowed format.

There is no 401: the endpoint is public. An unresolvable link is reported as valid: false with a 200, not an error. See Errors for the full error contract.

Join-link tasks

All operations

Create join link

Mint a link to resolve

Join links overview

Concepts and approval policies

Errors

Shared error contract

Disable join link List join links

⌘I

Getting Started

Operating Your Storefront

Inventory Sources

Real-Time Targeting (TMP)

Approvals & Reviews

Buyer Onboarding

Demand & Signals

Proposals & Agents

Buyer Routing

Analytics & Activity

Billing

Account

Request

Parameters

Response

Response fields

Errors

Join-link tasks

Create join link

Join links overview

Errors

​Request

​Parameters

​Response

​Response fields

​Errors

​Related

Join-link tasks

Create join link

Join links overview

Errors

Request

Parameters

Response

Response fields

Errors

Related