REST API
Interactive reference also ships at /docs/api.
Create a token
UI: /settings/api-tokens
Permission: api.tokens.manage
Feature: api
Pick scopes carefully; copy the token once.
Auth
Authorization: Bearer {token}
Accept: application/json
Base URL: https://your-domain/api/v1
Rate limit: 120 / minute
Scopes
| Scope | Access |
|---|---|
campaigns:read |
List/view campaigns |
campaigns:write |
Reserved |
locations:read |
List locations |
employees:read |
List employees |
feedback:read |
List inbox |
feedback:write |
Submit feedback |
analytics:read |
KPI overview |
distribution:urls |
Generate tracked URLs |
Main endpoints
GET /campaigns,GET /campaigns/{id}GET /locations,GET /employeesGET /feedback,POST /feedbackGET /analyticsPOST /tracked-urls
See /docs/api for curl examples and response envelopes.