Skip to content

List creators on a campaign

Lists every creator on one campaign, the same people the campaign's page in the Scouty dashboard shows, newest first and each person once: creators the team accepted or has still to accept, whether or not they have signed the contract, and creators in or through the activation flow. The signed field says whether they signed the contract, and activation where they are in the flow (null when they have not started it). A creator on the campaign only through activation has status "activating", and has memberId null when Scouty knows them only by phone. Creators who declined, were skipped, or were hidden from the dashboard are not listed. The total is signedCreators on scouty_list_campaigns.

GET/v1/campaigns/{campaignId}/applicants
  • Scopecreators:read
  • Read
  • MCP toolscouty_list_applicants

Markdown version for your agent

Authorization

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

Authorization: Bearer $SCOUTY_TOKEN

Path parameters

NameTypeRequiredDescription
campaignIdintegerRequired

The campaign to list creators on.

Query parameters

NameTypeRequiredDescription
statusstringOptional

Only creators who have signed the contract. Every creator on the campaign, activation included, when left out.

One of signed

cursorstringOptional

The nextCursor from the previous page.

limitintegerOptional

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

Pagination

This list comes a page at a time, in creators. Send limit (1 to 100, 25 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.