Skip to main content
GET
List retailer links

Authorizations

X-API-Key
string
header
required

Response

OK

id
string<shortuuid>
required

URL-safe 22-character shortuuid encoding of the row's UUID primary key. Stable across the row's lifetime; suitable for sharing in URLs, log lines, and external SDK clients. Accepted on input as either the shortuuid form or the canonical UUID form (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx).

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$
retailer_name
string
required

The retailer this link connects to, for display.

coverage_statement
string
required

Honest, non-technical statement of what this link means today. Placeholder pending C-4823 (coverage integrity) -- never implies a protection guarantee this data doesn't support.