Skip to main content
GET
List Retailer Credentials
Retrieve a list of all retailer credentials associated with your account.

Response

Returns an object containing:
  • credentials - Array of retailer credential objects
  • total - Total number of credentials
Each credential includes:
  • id - Unique identifier (UUID)
  • short_id - Short identifier used in URLs (e.g., zn_acct_a1b2c3d4)
  • email - Retailer account email
  • retailer - Retailer name, or null if default credentials
  • has_totp - Whether TOTP 2FA is configured
  • has_forwarding - Whether email forwarding has been verified
  • created_at - When the credentials were created
  • updated_at - When the credentials were last updated

Authorizations

Authorization
string
header
required

Zinc API key (Bearer zn_...)

Headers

authorization
string | null

Query Parameters

limit
integer
default:50

Page size (default 50, max 500). Responses include total for paging past it.

Required range: 1 <= x <= 500
offset
integer
default:0

Number of credentials to skip

Required range: x >= 0
search
string | null

Partial match on email or retailer

Response

Successful Response

Response model for list of retailer credentials.

credentials
RetailerCredentialsResponse · object[]
required
total
integer
required