Auth

Authentication for partner and account users (login, OAuth password grant, impersonation), plus public pre-login reference lookups.

Authentication for partner and account users (login, OAuth password grant, impersonation), plus public pre-login reference lookups.

Terminology

These docs use one name per concept. Where the field name differs, it is given here.

TermWhat it meansField name
PartnerThe top-level tenant. Reaches every account and location beneath it.partner_id
AccountA business within a partner. Owns locations, campaigns and reports.account_id
LocationA single site with its own review-site connections and reviews.store_id

brand appears in some field names and status values as the older name for an account, and store as the older name for a location. They refer to the same records.

Prerequisites

  • A bearer token in the Authorization header. Any endpoint that needs no token says so on its own page.
  • The id of each record the call targets. Every endpoint page lists the ids it needs.

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.

In this section

Authentication

OAuth 2.0 Bearer tokens (RS256-signed JWTs) for every protected request.

Open →

OAuth 2.0

Exchange a user's email and password for an access token and a refresh token (password grant).

Open →

OAuth clients

Admin-scoped OAuth client registration, plus the external JumpCloud OIDC SSO handoff.

Open →

Signup

Public, unauthenticated self-service onboarding wizard (no bearer token).

Open →

Impersonation

Partner-only token mint — act in an account owner's context.

Open →

Lookups

Public reference catalogs (countries, states, cities, feature options) for pre-login forms.

Open →


Did this page help you?