Skip to main content
GET
Get an action

Authorizations

X-Session-Token
string
header
required

Session token for authentication.

Path Parameters

action_id
string<uuid>
required

The unique identifier for the action.

Query Parameters

include
enum<string>[]

A comma separated list of related resources to include.

Available options:
assigned_users,
assigned_teams,
form_submission,
triggering_job_role,
closed_by

Response

Get an action.

JSON API response object

data
object
required

An action is a piece of work that needs doing, assigned to one or more users and/or teams. It has a lifecycle state (open / closed), a priority, an optional due date, and an optional polymorphic link back to whatever produced it (in v1, a form submission). Actions are produced both manually and by domain producers such as the data-capture workflow runner.

The subject is optional. When present, exactly the relationship matching subject_type is populated (v1: subject_type is form-submissions, so form_submission is the populated relationship). Manual actions can have no subject at all.

jsonapi
object
required
included
object[]

Related resources that can be included when an action is returned.

A user