Get the workspace's plan usage
Reports this workspace's plan usage for the current period: usage as one whole percent (usagePct), outreach credits used against the plan's, Creators Club invites used against the plan's, active campaigns against the plan's, how many Creators Club applicants are held until the plan starts, how many creator emails searches found, and when the counts reset. Usage is null for a workspace with no workspace plan, which includes every campaign on its own plan. Amounts are not part of this answer.
https://api.tryscouty.com/v1/usage - Scope
plan:read - Read
- MCP tool
scouty_get_usage
Authorization
Send a Scouty token as a bearer token in the Authorization header. The token needs the plan:read scope, or the call answers 403 insufficient_scope. Tokens and scopes
Authorization: Bearer $SCOUTY_TOKENErrors
A refusal answers { "error": { "code", "message" } }. Branch on code; the message is for a person. Every error and its fix
| Status | error.code | Meaning |
|---|---|---|
| 401 Unauthorized | missing_token invalid_token token_revoked token_expired token_orphaned | No token, or one that is not recognized, revoked or expired. |
| 403 Forbidden | insufficient_scope wrong_principal | The token does not carry the scope this capability needs. |
| 429 Too Many Requests | rate_limited | Too many requests this minute. Retry-After says how long is left. |