Skip to content

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/v1/campaigns/{campaignId}/plan
  • Scopeplan:read
  • Read
  • MCP toolscouty_get_plan

Markdown version for your agent

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_TOKEN

Path parameters

NameTypeRequiredDescription
campaignIdintegerRequired

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

Statuserror.codeMeaning
401 Unauthorizedmissing_token invalid_token token_revoked token_expired token_orphanedNo token, or one that is not recognized, revoked or expired.
403 Forbiddeninsufficient_scope wrong_principalThe token does not carry the scope this capability needs.
404 Not Foundnot_foundNo such route, or no such campaign for this client.
429 Too Many Requestsrate_limitedToo many requests this minute. Retry-After says how long is left.