Skip to content

Get a campaign's activation

Reads the activation flow for one campaign: whether it is published, whether creators are enrolled by the team or automatically, the titles of its steps, and where each creator has got to. The creators are a page at a time. A token without the creators:read scope gets the flow without them, and creatorsOmitted says so.

GET/v1/campaigns/{campaignId}/activation
  • Scopecampaigns:read
  • Read
  • MCP toolscouty_get_activation

Markdown version for your agent

Authorization

Send a Scouty token as a bearer token in the Authorization header. The token needs the campaigns:read scope, or the call answers 403 insufficient_scope. Tokens and scopes

Authorization: Bearer $SCOUTY_TOKEN

Path parameters

NameTypeRequiredDescription
campaignIdintegerRequired

The campaign whose activation to read.

Query parameters

NameTypeRequiredDescription
cursorstringOptional

The nextCursor from the previous page of creators.

limitintegerOptional

Creators per page, 1 to 100. 50 by default.

Pagination

This list comes a page at a time, in creators. Send limit (1 to 100, 50 by default) and pass the answer's nextCursor back as cursor for the next page. nextCursor is null on the last page.

Errors

A refusal answers { "error": { "code", "message" } }. Branch on code; the message is for a person. Every error and its fix

Statuserror.codeMeaning
400 Bad Requestinvalid_requestThe request was not the shape this capability takes, or its body was not JSON.
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.