Skip to main content
GET
List actions

Authorizations

Authorization
string
header
required

Headers

X-Workspace-Id
string<uuid>
required

UUID of the workspace to act in. Take it from GET /me (workspaces[].id). A key scoped to specific workspaces is rejected with 403 WORKSPACE_NOT_ALLOWED for any other id; a missing header is 400 WORKSPACE_REQUIRED.

Query Parameters

status
enum<string>

new: proposed by Surfaced, not yet accepted. in_progress: accepted, or created by hand (a manual action starts here); work on it is open. done: completed. declined: rejected. done and declined are archived: restore returns a declined action to the status it had, and otherwise a machine-proposed action to new and a manual action to in_progress. There is no todo status: to-do actions are in_progress.

Available options:
new,
in_progress,
done,
declined
source
enum<string>

Where the finding came from (the card is category): content_gap (a measured gap in AI answers), website_check (one failing website check, see GET /audit-report), backlink (a Backlink opportunity: a third-party page that shapes your visibility), manual (created through POST /actions).

Available options:
content_gap,
website_check,
backlink,
manual
category
enum<string>

Which of the three Actions cards the action sits under: content (Content gaps), website (Website audit) or backlink (Backlink opportunities). A manual action picks one when it is created. Not the same as source, which is where the finding came from.

Available options:
content,
website,
backlink
includeUnsupported
enum<string>
Available options:
true,
false
cursor
string
limit
integer
Required range: 1 <= x <= 100

Response

A page of actions

data
object[]
required
meta
object
required