Lookups

Public reference catalogs used by the signup wizard, partner provisioning, and any pre-login form that needs geographic or feature-option dropdowns.

Public reference catalogs used by the signup wizard, partner provisioning, and any pre-login form that needs geographic or feature-option dropdowns. No bearer token required — these routes sit inside the white-label public group.

Prerequisites

  • Gather the identifiers required by the endpoint you call. Each endpoint page lists the required IDs.

Errors

StatusMeaning
401The bearer token is missing, expired or invalid
403The token is valid but the record sits outside your account
422The request failed validation — the response names the fields
500Unexpected server error

Individual endpoints may return more; each page lists its own.

Endpoints

MethodEndpointDescription
GETGet feature optionsResolve a store/company to its owning company and returns plan feature options for feature-gating UI.
GETGet countriesGet the full list of countries as {label, value} pairs, ordered by name.
GETGet statesGet the states/regions for the given country_code as {label, value} pairs, ordered by name.
GETGet citiesGet the cities for the given country_code and state_code as {label, value} pairs, ordered by name.
POSTRefresh address cache (PUBLIC)Clear the forever-cached country / state / city reference lists so the next lookup rebuilds them.