HelpDevelopers
API keys
Owners and admins create keys. The secret is shown once. Keys are for the whole organization.
API keys belong to the organization, not to a person. Location managers do not get their own keys, and a key is not limited to one manager's locations.
Scopes are events:write, read:reviews, read:stats, read:requests. events:write is on Growth and above. The read scopes are on Scale and Franchise. A key that omits scopes stays write-only. You can keep up to 20 live keys. GET /api/v1/me accepts any live key and returns no secret.
Create and revoke
- An owner or admin opens API keys.
- Name the key, tick the scopes, and create it. Copy the secret then. Only a prefix is shown later.
- Revoke a key from the same page. A revoked key is rejected.