Skip to main content
GET
Get Actions

Authorizations

Authorization
string
header
required

An organisation service token, sent as Authorization: Bearer hrld_svc_... Scopes: scans:start starts service scans; scans:read reads them; managed:read reads brands, profile, overview, scores, competitors, actions and Snapshots in actively managed organisations; managed:share makes their restricted Snapshots unlisted.

Path Parameters

brand_id
string<uuid>
required

The brand's UUID from listBrands.

Query Parameters

limit
integer
default:20

Maximum rows (100).

Required range: 1 <= x <= 100
cursor
string | null

Prior next_cursor; keep filters and limit.

Maximum string length: 4096
as_of
string<uuid> | null

Completed scan id cutoff.

offset
integer
default:0

Rows to skip; prefer cursor paging.

Required range: x >= 0
group
enum<string> | null

Select an action work group.

Available options:
new,
your_input,
dispatched,
scheduled,
waiting,
settled,
withdrawn
assignee
enum<string> | null

me selects actions assigned to you; heralded selects actions with no person assigned. mine_or_open selects your own and unassigned work, including work whose owner cannot start work. Readers without permission to start work and service tokens see everyone. Omit for anyone.

Available options:
me,
heralded,
mine_or_open
topic
string<uuid> | null

Actions targeting this topic, its prompts or its pages.

subject
string | null

Keep the live actions about one subject: prompt:<uid>, topic:<id>, keyword:<id>, figure:<axis>, source:<domain>, competitor:<key>, engine:<id> or page:<url>. A subject the brand does not have matches nothing.

Maximum string length: 512
Pattern: ^(prompt|topic|keyword|figure|source|competitor|engine|page):.+$

Response

Successful Response

actions
V1Action · object[]
required
limit
integer
required
meta
Meta · object
required

Normalized query and newest included scan.

next_cursor
string | null
required

Pass as cursor with the same query to read the next page; null at the end.

offset
integer
required
suggestion_allowance
integer | null
required
suggestions_kept
integer
required
total
integer
required
subject_label
string | null

The subject's name: the prompt's text, the topic's name, the keyword, the figure, the domain or the competitor. Served when subject is sent; null when the brand has no such subject.