Skip to main content
GET
List actions

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

offset
number
default:0
Required range: x >= 0
limit
number
default:20
Required range: 1 <= x <= 100

Search by title or description substring

status
enum<string>[]

Filter by status. Accepts comma-separated or repeated params: ?status=new,in_progress

new: not started · in_progress: an executor is running · processed: finished. Same vocabulary as backlinks, citations and people-also-ask, with the extra middle state only actions can have.

Available options:
new,
in_progress,
processed
types
enum<string>[]

Filter by kind of work. Accepts comma-separated or repeated params: ?types=write_article. Omit for every type. Validated as strings rather than against the enum, so an unknown value returns nothing instead of a 400 once more types exist.

What kind of work an action is, and what else the body needs:

  • write_article — plan a piece of content, then call POST /v1/actions/:id/generate to write it. Requires no target.
  • update_article — any edit to an existing article, with the instruction in additionalInstructions. Requires articleId.
  • earn_link — go after a referring domain your competitors have. Requires backlinkId.
  • get_cited — get onto a page AI engines already cite. Requires citationId.
  • reply_thread — reply on a cited Reddit or Quora thread. Requires citationId.
  • record_video — make a video of your own, since you cannot be added to someone else's. Requires citationId.
  • track_competitor — start tracking a brand RankSpot discovered in AI answers. Requires competitorId.
  • add_prompt — track a question buyers ask that no existing prompt covers. Requires no target.
  • publish_article — push a finished article to the workspace integrations. Requires articleId.
  • request_indexing — ask Google to index a published page it has missed. Requires articleId.
  • other — anything you just want written down. Requires no target.
Available options:
write_article,
update_article,
earn_link,
get_cited,
reply_thread,
record_video,
track_competitor,
add_prompt,
publish_article,
request_indexing,
other

Response

200 - application/json
data
object