Skip to main content
GET
Get Action

Authorizations

Authorization
string
header
required

An API key, sent as Authorization: Bearer hrld_....

Path Parameters

action_id
string<uuid>
required

An action id from list_actions.

Query Parameters

limit
integer
default:5

Section page size, at most 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
with_details
boolean
default:true

Include all sections; false returns a compact preview.

with_viewer
boolean
default:false

Include the caller's visible activity names, kit, rewrite allowance and whether the work is assigned to them.

section
enum<string> | null

Read one paged section instead of all detail.

Available options:
activity,
pages,
targets,
versions,
evidence,
sources,
emails
step
string | null

With section=activity, page only the events of this step, by its key.

Maximum string length: 40

Response

Successful Response

application
V1ActionApplication · object | null
required
asset
V1Asset · object | null
required

The current asset, null before one has been made.

assignee
AssigneeResponse · object | null
required
blocked_owner
string | null
required
brand_id
string<uuid>
required
check_again_on
string<date> | null
required
checklist
string[]
required

The steps you follow where Heralded drafts and applies nothing: a site check's fix as Site Health shows it, or a listing's steps. Empty on other work.

citation_count
integer
default:0
required

Distinct engine and prompt citation pairs before the list cap.

citations
FirstCitation · object[]
required

Distinct engine and stable prompt citation pairs in the publication measurement window, capped at five.

completed_at
string<date-time> | null
required
content_piece
V1ActionPiece · object | null
required
correspondence
V1Correspondence · object | null
required

The emails of a task with a source and whose move it is; null on work that writes no email.

created_at
string<date-time>
required
credit_cost
integer
required
credits_spent
integer
required

Content credits charged to this work and not refunded.

current_draft_version
integer | null
required

The draft version this action shows; null without a draft, or when the newest one was written for another route.

current_step
string | null
required
delivered_at
string<date-time> | null
required

When the result went live, was sent or was published; null on dismissed work.

demand
string
required

What the work waits on, in a line.

detail
string | null
required
dismissal_reason
enum<string> | null
required

Why a member put the work away, while it stays put away. not_now defers it four weeks. too_much_work, not_relevant and already_done dismiss it, and not_relevant also stops Heralded suggesting that play for that target again. Null when no reason was given and once the work is restored.

Available options:
not_now,
too_much_work,
not_relevant,
already_done
dispatchable
boolean
required
done_when
string | null
required

When the work is done.

draft_in_flight
enum<string> | null
required
Available options:
drafting,
redrafting
drafts
V1ActionDraft · object[]
required
ending
EndingResponse · object | null
required

How the task ended, such as No reply, Stopped or Not relevant, and when; null while it is open. outcome keeps its meaning.

evidence
TaskEvidence · object | null
required

Linked prompts and rendered answer counts from the latest report.

expected_impact_pts
integer | null
required

Always null: the expected gain is gain.

first_citation
FirstCitation · object | null
required

First qualifying citation of the delivered page.

fixed_pages
string[]
required

Previously affected pages checked as passing by a later Website read.

focus
FocusTag · object | null
required

The starred topic or competitor the work serves, or outside your focus.

gain
GainResponse · object | null
required

The expected gain: its band (high, medium or low, null on work you asked for) and what the work aims at.

gate
enum<string> | null
required
Available options:
approval,
review
grounds
GroundsResponse · object | null
required

What the work rests on: its kind, its likely cause, the dated evidence, the prompt or keyword results it targets and, for best practice, the publisher guidance. Null on work filed before actions carried their grounds.

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

Who holds the work: you, Heralded or a third party; null when nobody holds it.

Available options:
you,
heralded,
waiting
id
string<uuid>
required
impact_scale
string | null
required

Every scan that created or reprioritised this action, oldest first.

job
JobResponse · object
required

What this row's task is as a job (#2429): every stage, where it stands, what happens next and what the button does. Composed per kind by app.actions.jobs.describe_job; no surface keeps a second table.

kind
string
required
kind_tag
string | null
required

A tag on the kind of work, such as Sponsored; null on work that has none.

looks_resolved_evidence
Looks Resolved Evidence · object | null
required

The last observed finding when the work appears resolved.

member
enum<string> | null
required

The responsible team member; null for setup and prompt replacements.

Available options:
writer,
publicist,
engineer,
analyst
meta
Meta · object
required

Normalized query and newest included scan.

not_seen_since_run
integer | null
required

First read that stopped seeing this suggestion; null when seen.

note
TaskNote · object | null
required

Task explanation with a live job step.

outcome
enum<string> | null
required
Available options:
verified_up,
no_move,
not_measured,
dismissed
pages
string[]
required

Affected page URLs, separate from the instructions in checklist.

pages_remaining
integer | null
required

Affected pages still requiring a fix before paging.

paid_off_at
string<date-time> | null
required

When verification credited a positive measured gain; null on dismissed work.

piece_preview
V1ActionPiecePreview · object | null
required

Compact piece state without its document or images; present on preview reads.

placed_position
integer | null
required

Position in the brand's proposed order; null when Heralded ranks it.

platform
boolean
required
preview
string | null
required

Up to 400 characters of draft opening, email recipient and subject, or planned change while waiting on you.

primary_verb
required
Available options:
dispatch,
take,
done,
defer,
dismiss,
confirm,
reject,
restore,
block,
unblock,
reopen
prompt_movement
string | null
required
recipient
V1ArtifactRecipient · object | null
required

Who an outreach task's email is addressed to and where its address was found; null on other work.

results
ActionResults · object
required

Grouped observations, citation headline, connection offer and measured outcome for delivered work.

return_group
enum<string> | null
required
Available options:
new,
your_input,
dispatched,
scheduled,
waiting,
settled,
withdrawn
route
string
required
scheduled_for
string<date> | null
required
secondary_verbs
enum<string>[]
required
Available options:
dispatch,
take,
done,
defer,
dismiss,
confirm,
reject,
restore,
block,
unblock,
reopen
segment
string
required
settled_at
string<date-time> | null
required
stage
enum<string>
required

The work's stage: observe, decide, do or verify.

Available options:
observe,
decide,
do,
verify
started_at
string<date-time> | null
required

The action's first start by Heralded; null on dismissed work.

state
enum<string>
required
Available options:
new,
accepted,
in_progress,
blocked,
looks_resolved,
done,
verified_no_move,
deferred,
dismissed,
withdrawn
steps
V1ActionJobStage · object[]
required
target_entity
string
required
targets
V1ActionTarget · object[]
required

Questions and searches on the requested page.

thread
V1ActionStep · object[]
required
title
string | null
required
tracking
enum<string>[]
required

What Heralded tracks once the work is live.

Available options:
live,
crawled,
ranked,
search_console,
cited,
moved
trail
TrailEntry · object[]
required

What happened since the work was delivered: one entry per signal in tracking, then the measured result. A site fix's measured result is its live entry. Empty until the work is delivered.

updated_at
string<date-time>
required
verified_impact_pts
number | null
required
wait
WaitResponse · object | null
required

What the task waits for, on whom, until when and who acts then; null while it waits on nobody.

waiting_since
string<date-time> | null
required

When the current ask began; null outside your_input.

write_language
string | null
required
write_language_locked
boolean
default:false
required
write_language_source
string | null
required
page
ActionSection · object | null

The requested section page and continuation.

section_totals
Section Totals · object

Rows in each compact section before paging.

viewer
ActionViewerResponse · object | null

The kit, redraft allowance and activity names visible to this caller.