Finding IDs (foreign keys)
Which endpoint returns each ID you need to call the rest of the API.
Most endpoints take IDs — store_id, review_site_id, campaign_id, plan_id and
so on. These are foreign keys that reference another resource. This page tells you which
endpoint to call to obtain each ID.
IDs are integers unless noted. Pass them in the path, body or query exactly as eachendpoint'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
| Foreign key | Identifies | Get it from |
|---|---|---|
store_id | A store / location | List stores — account · List stores — partner |
company_id / brand_id / account_id | An account / account (company) | List accounts — partner · List child accounts — account |
review_site_id | A review site (publisher) | Review-site catalogue · Review sites for a store |
store_review_site_id | A store's specific review-site link | List review sites for a store |
city_id | A city (address lookup) | List cities |
companyindustry_id | An industry | List account industries |
partner_id | Your own partner account | Returned by Login as company.id (when bundle_id = 1) |
Plans
| Foreign key | Identifies | Get it from |
|---|---|---|
plan_id | A plan | List plans — partner · List plans — account |
Users
| Foreign key | Identifies | Get it from |
|---|---|---|
user_id | A user | List users |
Campaigns & templates
| Foreign key | Identifies | Get it from |
|---|---|---|
campaign_id | A campaign | List campaigns |
email_template_id | An email template | List email templates |
sms_template_id | An SMS template | List SMS templates |
landing_page_id | A landing-page template | List landing-page templates |
file_header_id | A CSV automation file-header set | List automation campaigns |
QR codes
| Foreign key | Identifies | Get it from |
|---|---|---|
qr_code_id | A QR code | List QR codes |
template_id (QR) | A QR template | List QR templates |
Reviews, responses & AI
| Foreign key | Identifies | Get it from |
|---|---|---|
review_id | A review | Review-response feed |
ai_response_id | A stored AI response | List AI responses for a review |
Reports
| Foreign key | Identifies | Get it from |
|---|---|---|
competitive_report_id | A competitive report | List competitive reports |
insight_report_id | An insight report | Submit insight report (returned on submit) |
report_id | A saved email / user report | List email reports |
Widgets
| Foreign key | Identifies | Get it from |
|---|---|---|
widget_type_id | A widget type | List widget types |
Webhooks & notifications
| Foreign key | Identifies | Get it from |
|---|---|---|
webhook_subscription_id | A webhook subscription | List subscriptions |
notification_id | An error notification | List error notifications |
Auth & onboarding
| Foreign key | Identifies | Get it from |
|---|---|---|
client_id (OAuth) | An OAuth client | List OAuth clients |
bulk_import_id | A bulk-import job | Bulk import accounts + locations (returned on upload) |
Updated 18 days ago
Did this page help you?