List human review tasks assigned to the current user
List all human review tasks assigned to the current user.
Returns a paginated list of human review tasks that have been assigned to the currently authenticated user. Tasks are joined with assignments to filter by user.
Context:
- Returns only tasks assigned to the current user
- Excludes soft-deleted tasks
- Results are paginated using offset and limit
- Tasks can be filtered by one or more statuses (optional, comma-separated)
- Tasks can be filtered by target task name (optional)
- Tasks can be filtered by source task name (optional)
- Tasks can be filtered by flow execution ID (optional)
- Tasks are returned in the order they appear in the database
Use Cases:
- Display user’s assigned review tasks in a dashboard
- Show pending reviews for the current user
- Filter tasks by status (e.g., only show pending tasks)
- Filter tasks by multiple statuses (e.g., ‘pending,in_progress’)
- Filter tasks by specific target task name, source task name, or flow execution
- Track review task assignments
Related Endpoints:
- POST /human-review-tasks - Create a new review task
- GET /human-review-tasks/ - Get specific task details
Authorizations
API key authentication. Include your API key in the X-API-Key header as: X-API-Key YOUR_API_KEY
Example:
JWT Bearer token authentication. Include your access token in the Authorization header as: Bearer YOUR_ACCESS_TOKEN
Example:
Query Parameters
Number of records to skip for pagination
x >= 0Maximum number of records to return
1 <= x <= 1000Filter tasks by status(es). Valid values: 'pending', 'in_progress', 'completed'. Multiple statuses can be provided as comma-separated values (e.g., 'pending,in_progress').
Filter tasks by target task name
Filter tasks by source task name
Filter tasks by flow execution ID
Response
List of human review tasks retrieved successfully
UUID of the flow execution this task is associated with.
"550e8400-e29b-41d4-a716-446655440000"
UUID of the organization this task belongs to.
"550e8400-e29b-41d4-a716-446655440000"
Index of the source task execution that created this review.
0
Name of the source task that created this review.
"process_document"
Status of the task. Valid values: 'pending', 'in_progress', 'completed'.
"pending"
Index of the target task execution.
0
Name of the target task being reviewed.
"receive_file"
Timestamp when the task was completed. Null for not completed tasks.
"2024-01-01T00:00:00Z"
UUID of the user who completed this task. Null for not completed tasks.
"550e8400-e29b-41d4-a716-446655440000"
Instructions for the human reviewer on how to complete this task.
"Please review the document and verify all dates are correct."
Review result: True for correct, False for incorrect, null for not yet finished.
true
JSON output of the completed review. Null for not yet completed tasks.
Additional metadata associated with the human review task.