466169815b78
List actions
Retrieves a paginated list of actions with filtering and sorting capabilities.
For detailed information about actions, action types, and action statuses, see the Prewave Help Center.
Quick Start:
GET /public/v1/actions?page=0&size=20
Response Format: Returns a lightweight summary view optimized for list/table displays. For complete action details including full descriptions, action items, and attachment metadata, use GET /public/v1/actions/{actionId}.
Filtering: All filter parameters are optional and can be combined. Multiple values are passed as comma-separated lists (e.g., typeIds=5,6,7).
Finding Valid Filter Values:
- Target IDs: Use GET /public/v2/suppliers/sites to get valid prewaveTargetId values
- Action Types & Status IDs: Use GET /public/v1/actions/types to get valid action type IDs and GET /public/v1/actions/statuses to get valid status IDs
- Team IDs & User IDs: Available in your organization's team and user management interfaces
Performance:
- Response payloads are optimized for list views (60-80% smaller than full detail responses)
- Using multiple filters may impact query performance
- Text search (query parameter) searches across title and description fields
- Date range filters are inclusive (both endpoints included)
- Use pagination (page, size) to limit response size for large result sets
Required Permission: access_public_actions
Query parameters
Zero-based page index (0..N)
The size of the page to be returned
Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
Filter by action type IDs. Multiple values: comma-separated (e.g., '5,6,7') or repeated parameter. Use GET /public/v1/actions/types to find valid type IDs.
Filter by status IDs. Multiple values: comma-separated (e.g., '2,3') or repeated parameter. Use GET /public/v1/actions/statuses to find valid status IDs.
Filter by target/supplier IDs (prewaveTargetId). Multiple values: comma-separated (e.g., '102006215,102006216') or repeated parameter
Filter by assignee user IDs. Multiple values: comma-separated (e.g., '100,101') or repeated parameter
Filter by team IDs. Multiple values: comma-separated (e.g., '10,11') or repeated parameter
Filter by organization/site group IDs. Multiple values: comma-separated (e.g., '500001') or repeated parameter
Due date from (ISO 8601 timestamp)
Due date to (ISO 8601 timestamp)
Creation date from (ISO 8601 timestamp)
Creation date to (ISO 8601 timestamp)
Update date from (ISO 8601 timestamp)
Update date to (ISO 8601 timestamp)
Text search in title/description (case-insensitive)
Response
Successfully retrieved actions
Example response
{
"content": [
{
"actionId": 12345,
"title": "Review supplier compliance",
"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"
},
"dueDate": "2024-12-31T23:59:59Z",
"createdAt": "2024-01-15T10:30:00Z",
"updatedAt": "2024-01-20T14:45:00Z"
}
]
}