Finding IDs

Most calls take an id: a location's store_id, a review's review_id, a plan's plan_id. This page says where each one comes from.

Use your own IDs where you can

You don't have to store our ids at all. When you create an account or location, attach your own identifier as client_account_id or client_location_id. Most endpoints that take an account or location accept your id in place of ours; each endpoint page says whether it does. This keeps your system the source of truth and saves a lookup on every call.

Naming

Three names appear for the same id: company_id, brand_id, and account_id all mean an account's id. They're identical values; the different names are historical. Where an endpoint uses one, pass the account's id. In new pages we say account_id. Similarly store_id and location mean the same thing: store_id is the location's id.

📘

IDs are integers unless noted. Pass them in the path, body or query exactly as each

endpoint's page documents. In the Postman collection, most list/create requests have a
test script that captures the returned id into a {{…Id}} variable automatically, so
later requests are pre-filled.

Core resources

Plans

Users

Campaigns & templates

QR codes

Reviews, responses & AI

Reports

Widgets

Webhooks & notifications

Auth & onboarding