Skip to content

Get action item

GET
/action-items/{actionItemId}
curl --request GET \
--url https://safe-api.safetyradar.com/v2/action-items/123e4567-e89b-12d3-a456-426614174000 \
--header 'Authorization: Bearer <token>' \
--header 'x-team: my-team-slug'

Get a single action item by its UUID.

actionItemId
required

Action item UUID

string format: uuid
Example
123e4567-e89b-12d3-a456-426614174000

Action item UUID

x-team

Deprecated — accepted but ignored; the v2 API is org-scoped.

string
Example
my-team-slug

Deprecated — accepted but ignored; the v2 API is org-scoped.

Action item

Media typeapplication/json
object
data
required
object
id
required
string format: uuid
entityType
required
string
nullable
entityId
required
string format: uuid
nullable
formSubmissionId
required
string format: uuid
nullable
sourceSectionNodeId
required
string
nullable
title
required
string
description
required
string
nullable
assignedToUserId
required
string format: uuid
nullable
assignedToUserName
string
nullable
assignedToDepartmentId
required
string format: uuid
nullable
assignedToRoleSlug
required
string
nullable
dueDate
required
string
nullable
priority
required
string
Allowed values: low medium high urgent
statusId
required
string format: uuid
nullable
statusName
required
string
nullable
statusGroup
required
string
nullable
Allowed values: new in_progress complete on_hold cancelled
status
required
string
Allowed values: open in_progress complete
assetId
required
string format: uuid
nullable
assetName
required
string
nullable
externalId
required
string
nullable
responseNotes
required
string
nullable
attachments
required
Array<object>
nullable
object
key
additional properties
nullable
completedAt
required
string
nullable
completedById
required
string format: uuid
nullable
completedByName
required
string
nullable
createdById
required
string format: uuid
nullable
fields
required

The organization’s custom module fields, keyed by definition key. Always present; {} when the organization has configured none, and a defined key this item holds no value for is absent rather than null. Discover the keys, types and filter operators at GET /v2/modules/action_item/fields.

object
key
additional properties
any
metadata
required

Verbatim, unvalidated. Use fields — typed, admin-defined, validated. See GET /v2/modules/action_item/fields.

object
key
additional properties
nullable
organizationId
required
string format: uuid
teamId
required
string format: uuid
nullable
createdAt
required
string
updatedAt
required
string
Example
{
"data": {
"priority": "low",
"statusGroup": "new",
"status": "open",
"fields": {
"crew": "A-shift",
"corrective_cost": 1250
}
}
}

Unauthorized

Media typeapplication/json
object
code
required
string
message
required
string
details
object
key
additional properties
nullable
Examplegenerated
{
"code": "example",
"message": "example",
"details": {
"additionalProperty": "example"
}
}

Action item not found

Media typeapplication/json
object
code
required
string
message
required
string
details
object
key
additional properties
nullable
Examplegenerated
{
"code": "example",
"message": "example",
"details": {
"additionalProperty": "example"
}
}