Endpoints
| Method | Path | Description |
|---|---|---|
GET | /api/keys/validate | Check if a key is active and retrieve its metadata |
GET | /api/keys/usage | Get request usage stats for a key |
GET | /api/keys/create | Create a new API key (admin only) |
Validate a key
Check whether an API key is valid and retrieve its metadata.Request
The API key to validate.
Response
true if the key is active, false otherwise.Label assigned to the key when it was created.
Maximum number of API calls per calendar month.
Number of calls made in the current calendar month.
Example
Get usage stats
Returns per-endpoint usage breakdown for a key in a given month.Request
Your API key.
Year to query (defaults to current year).
Month to query, 1–12 (defaults to current month).
Response
Year of the usage period.
Month of the usage period.
Total API calls in the period.
Monthly request limit for this key.
Per-endpoint request counts.
Example
Create a key
Creates a new API key and stores it in the database.Request
A label for the key (e.g. company name or integration name).
Contact email associated with the key.
Maximum API calls per calendar month.
Response
The newly created API key. Store this immediately — it cannot be retrieved again.
Label for the key.
Monthly request limit.
