Get action by ID

Retrieves detailed information about a specific action.

For detailed information about actions, action types, and action statuses, see the Prewave Help Center.

Quick Start:

GET /public/v1/actions/12345

Response: Returns comprehensive action details including description, creator, action items, skip information, and attachment metadata.

Action ID: The actionId is a stable identifier that uniquely identifies an action. Once created, it never changes, making it safe for:

Storing in your database for future reference
Using in URLs and bookmarks
External references and integrations

To find action IDs, use GET /public/v1/actions to list all actions and retrieve their actionId values.

Related Operations:

GET /public/v1/actions - List all actions (to find actions by other criteria)

Required Permission: access_public_actions

get/public/v1/actions/{actionId}

Path parameters

actionIdinteger required

Action key (stable identifier). Use GET /public/v1/actions to find action keys.

Response

Action found and returned successfully

actionIdinteger required

Public-facing action key

titlestring required

Action title

descriptionstring nullable

Action description

dueDatestring date-time nullable

Due date (ISO 8601 timestamp)

createdAtstring date-time required

Creation timestamp (ISO 8601 timestamp)

updatedAtstring date-time required

Last update timestamp (ISO 8601 timestamp)

Example response

{
  "actionId": 12345,
  "title": "Review supplier compliance",
  "description": "Please review the compliance documentation",
  "type": {
    "id": 5,
    "displayName": "Incident Review"
  },
  "status": {
    "id": 3,
    "title": "In Progress",
    "state": "InProgress"
  },
  "target": {
    "id": 102006215,
    "name": "Acme Corporation"
  },
  "assignees": [
    {
      "id": 100,
      "name": "John Doe",
      "email": "john.doe@example.com"
    }
  ],
  "teams": [
    {
      "id": 10,
      "name": "Compliance Team"
    }
  ],
  "organization": {
    "id": 102006215,
    "name": "Acme Corporation"
  },
  "creator": {
    "id": 100,
    "name": "John Doe",
    "email": "john.doe@example.com"
  },
  "dueDate": "2024-12-31T23:59:59Z",
  "createdAt": "2024-01-15T10:30:00Z",
  "updatedAt": "2024-01-20T14:45:00Z",
  "mainItem": {
    "id": 1001,
    "type": "Alert",
    "entityId": 5001
  },
  "executionItem": {
    "id": 1001,
    "type": "Alert",
    "entityId": 5001
  },
  "attachmentItems": [
    {
      "id": 1001,
      "type": "Alert",
      "entityId": 5001
    }
  ],
  "skipInfo": {
    "reason": "NotApplicable",
    "otherText": "Supplier no longer active",
    "endDate": "2024-12-31T23:59:59Z"
  }
}