Get a campaign's plan
Reports the plan covering one campaign: how many creators it may sign this period, how many it has signed and activated, and when the period ends. Amounts and billing links are not part of this answer.
GET
https://api.tryscouty.com/v1/campaigns/{campaignId}/plan - Scope
plan:read - Read
- MCP tool
scouty_get_plan
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_TOKENPath parameters
| Name | Type | Required | Description |
|---|---|---|---|
campaignId | integer | Required | The campaign whose plan to read. |
Errors
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. |
| 404 Not Found | not_found | No such route, or no such campaign for this client. |
| 429 Too Many Requests | rate_limited | Too many requests this minute. Retry-After says how long is left. |