The LocalUp REST API lets your developers connect other systems — a CRM, a BI tool, your website — to your data: locations, reviews and more. The API screen is where you create API keys, subscribe to webhooks, watch request logs and open the API reference.
Open it from the sidebar: Other → API. If you don't see the item, API access is not enabled for your account — ask your account manager. If the screen says you have no access, your role doesn't allow managing API keys.
Quick start
The Quick start block shows a sample request. All endpoints live under /api/v1 on your cabinet address, and every request carries an API key in the Authorization header:
curl https://<your cabinet address>/api/v1/locations \
-H "Authorization: Bearer <your API key>"
Every request is limited to your account's data.
API keys
The API keys table lists your keys with their Scopes, Status (active or revoked), Created and Last used dates.
- Create key — creates a key with a name and the scopes it may use. See Create an API key.
- Rotate — issues a new token for the key; the current token stops working immediately.
- Revoke — disables the key; calls made with it start failing immediately. This cannot be undone.
Webhooks
Webhooks let LocalUp notify your system when something happens, instead of your system asking repeatedly. Click New webhook, enter a Name, the URL that should receive the events and the Events to subscribe to, then click Create webhook.
LocalUp then sends a signed POST request to your URL whenever a selected event fires. After creation you see the signing secret once — store it and use it to verify that requests really come from LocalUp.
In the table you can Send test to queue a test event, check the Last delivery result (OK or Failed) and delete a subscription.
Request logs
Request logs · last 30 days lists API calls made with your keys: Time, Method, Path, Status, Duration and Key. Filter by response status to find failing calls; use the refresh button to update the list.
API reference
Click API reference (top right) to open the full documentation of the endpoints available to your keys: base URL, authentication, rate limits, the scopes each endpoint requires, parameters, request and response schemas, and examples. Download OpenAPI saves the machine-readable specification for code generators and API tools.
Each key has a limit on requests per minute, shared with the MCP server. When the limit is exceeded, the API answers 429 with a Retry-After header. The exact limit is shown in the API reference.