Skip to main content
GET
List recommended actions

Authorizations

Authorization
string
header
required

Path Parameters

organization_id
string<uuid>
required

Organization identifier

workspace_id
string<uuid>
required

Workspace identifier

Query Parameters

brand
string

Filter by brand

category
string

Filter by category

channel
string

Filter by channel

country
string

Filter by country

include_tasks
boolean
default:true

When false, each item omits tasks (and their generated brief bodies) and logs. Retrieve a single recommended action to read them.

limit
integer

Maximum number of recommended actions to return. Omit to return every match.

offset
integer

Number of matching recommended actions to skip, in the requested ordering. Defaults to 0.

opportunity
string

Filter by opportunity

ordering
enum<string>

Sort order. A leading - sorts descending. Results without a score come last when sorting by score. Defaults to -created_at (newest first).

Available options:
-created_at,
-score,
created_at,
score
score
integer

Filter by score

score__gte
integer

Only return recommended actions whose score is greater than or equal to this value

team
string

Filter by team

workflow_status
enum<string>

Filter by workflow status bucket. One of: new (default queue), confirmed (my plan), dismissed. Omit to return all statuses.

Available options:
confirmed,
dismissed,
new

Response

List of recommended actions

description
string
required

Detailed description of the action

details
string
required

Detailed markdown tasks and examples

opportunity
object | null
action
object | null
id
string | null

Recommended action result UUID

pipeline_run_id
string | null

Recommendation pipeline run UUID that produced this result, if any

organization_id
string | null

Organization ID

workspace_id
string | null

Workspace ID

team
string[] | null

Teams responsible for the action

effort
string | null

Effort required to perform the action

impact
string | null

Impact of the action on the brand

criticality
string | null

Criticality level of the action

timeline
string | null

Timeline required to perform the action

reasoning
string | null

Reasoning behind the recommendation

channel
string | null

Channel this action relates to

category
string | null

Category this action relates to

brand
string | null

Brand this action relates to

country
string | null

Country this action relates to

score
integer | null

Score from 0 to 100

action_label
string | null

Human-readable contextual title for the recommendation

tasks
object[]

Activable tasks generated by the pipeline for this recommendation

brief_generation_status
string
default:not-started

Brief generation lifecycle: not-started (never run), pending, in-progress, generated, error

workflow_status
string
default:new

User-facing plan status: new (default), confirmed (on my plan), dismissed

dismiss_reason
enum<string> | null

Reason for dismissal; null when not dismissed

  • not_relevant - not_relevant
  • already_implemented - already_implemented
  • not_feasible - not_feasible
  • deprioritised - deprioritised
Available options:
not_relevant,
already_implemented,
not_feasible,
deprioritised,
null
dismiss_comment
string | null

Optional free-text comment on dismissal

dismiss_date
string<date-time> | null

Timestamp when the action was dismissed