Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
The Scoutworks API is in beta. Try it now with the sandbox key, or ask to join the beta to use it with your own group.
Every error has the same shape. Branch on the code, never on the message.
{
"error": {
"code": "insufficient_scope",
"message": "This API key does not have the \"events:read\" scope. A group admin can add it in Settings → Integrations → API keys."
}
}
code. The message is written for people. We may change its wording at any time.
| Status | code | What it means | What to do |
|---|---|---|---|
| 400 | invalid_request | A query parameter or cursor is wrong: a typo, an unknown parameter or a value out of range. | Check the parameter against the API reference. |
| 401 | invalid_api_key | No key, or a key that is unknown, revoked or expired. It also happens when the admin who created the key is no longer a group admin. | Check the key. See When a key stops working. |
| 403 | insufficient_scope | The key does not have the scope this endpoint needs. | Add the scope to the key in Scoutworks. |
| 404 | not_found | No such record in your group. | Check the ID. IDs from another group are never found. |
| 429 | rate_limited | Too many requests. | Wait retryAfter seconds, then try again. See Rate limits. |
| 500 | internal_error | Something went wrong on our side. | Try again later. If it keeps happening, send us the errorRef. |
retryAfter on a 429: the number of seconds to wait.errorRef on a 500: a short reference. Quote it when you contact us, and we can find the exact request.