Tasks
API Reference for ProcessMaker Task API
Create a new Settings css-override
POST /api/1.0/customize-ui HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 43
{
"variables": "text",
"sansSerifFont": "text"
}
success
{
"key": "text",
"config": [
{}
],
"name": "text",
"helper": "text",
"group": "text",
"format": "text",
"hidden": true,
"readonly": true,
"variables": "text",
"sansSerifFont": "text",
"id": "text",
"created_at": "2025-07-04T19:26:10.013Z",
"updated_at": "2025-07-04T19:26:10.013Z"
}
Display a listing of the resource.
Filter results by string. Searches Name, Description, and Status. Status must match exactly. Others can be a substring.
Field to order results by
asc
Possible values: 10
GET /api/1.0/task_assignments HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
list of task assignments
{
"data": [
{
"process_id": 1,
"process_task_id": "text",
"assignment_id": 1,
"assignment_type": "ProcessMaker\\Models\\User",
"id": 1,
"created_at": "2025-07-04T19:26:10.013Z",
"updated_at": "2025-07-04T19:26:10.013Z"
}
],
"meta": {}
}
Store a newly created task assignment in storage.
Represents a business process task assignment definition.
POST /api/1.0/task_assignments HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 106
{
"process_id": 1,
"process_task_id": "text",
"assignment_id": 1,
"assignment_type": "ProcessMaker\\Models\\User"
}
{
"process_id": 1,
"process_task_id": "text",
"assignment_id": 1,
"assignment_type": "ProcessMaker\\Models\\User",
"id": 1,
"created_at": "2025-07-04T19:26:10.013Z",
"updated_at": "2025-07-04T19:26:10.013Z"
}
Update a task assignment
ID of task assignment to update
Represents a business process task assignment definition.
PUT /api/1.0/task_assignments/{task_assignment} HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 106
{
"process_id": 1,
"process_task_id": "text",
"assignment_id": 1,
"assignment_type": "ProcessMaker\\Models\\User"
}
No content
Remove an assignment
ID of task assignment to delete
Represents a business process task assignment definition.
DELETE /api/1.0/task_assignments/{task_assignment} HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 106
{
"process_id": 1,
"process_task_id": "text",
"assignment_id": 1,
"assignment_type": "ProcessMaker\\Models\\User"
}
success
No content
Display a listing of the resource.
Process request id
Filter results by string. Searches Name, Description, and Status. Status must match exactly. Others can be a substring.
Field to order results by
asc
Possible values: Include data from related models in payload. Comma separated list.
""
GET /api/1.0/tasks HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
list of tasks
{
"data": [
{
"user_id": "text",
"status": "text",
"due_at": "2025-07-04T19:26:10.013Z",
"initiated_at": "2025-07-04T19:26:10.013Z",
"riskchanges_at": "2025-07-04T19:26:10.013Z",
"subprocess_start_event_id": "text",
"data": {},
"id": "text",
"process_id": "text",
"process_request_id": "text",
"element_id": "text",
"element_type": "text",
"element_index": "text",
"element_name": "text",
"created_at": "2025-07-04T19:26:10.013Z",
"updated_at": "2025-07-04T19:26:10.013Z",
"advanceStatus": "text",
"due_notified": 1,
"user": {},
"process": {},
"process_request": {}
}
],
"meta": {
"filter": "text",
"sort_by": "text",
"sort_order": "asc",
"count": 1,
"total_pages": 1,
"current_page": 1,
"form": 1,
"last_page": 1,
"path": "text",
"per_page": 1,
"to": 1,
"total": 1
}
}
Display the specified resource.
task id
include
GET /api/1.0/tasks/{task_id} HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
"user_id": "text",
"status": "text",
"due_at": "2025-07-04T19:26:10.013Z",
"initiated_at": "2025-07-04T19:26:10.013Z",
"riskchanges_at": "2025-07-04T19:26:10.013Z",
"subprocess_start_event_id": "text",
"data": {},
"id": "text",
"process_id": "text",
"process_request_id": "text",
"element_id": "text",
"element_type": "text",
"element_index": "text",
"element_name": "text",
"created_at": "2025-07-04T19:26:10.013Z",
"updated_at": "2025-07-04T19:26:10.013Z",
"advanceStatus": "text",
"due_notified": 1,
"user": {},
"process": {},
"process_request": {}
}
Updates the current element
ID of task to update
COMPLETED
PUT /api/1.0/tasks/{task_id} HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 32
{
"status": "COMPLETED",
"data": {}
}
{
"user_id": "text",
"status": "text",
"due_at": "2025-07-04T19:26:10.013Z",
"initiated_at": "2025-07-04T19:26:10.013Z",
"riskchanges_at": "2025-07-04T19:26:10.013Z",
"subprocess_start_event_id": "text",
"data": {},
"id": "text",
"process_id": "text",
"process_request_id": "text",
"element_id": "text",
"element_type": "text",
"element_index": "text",
"element_name": "text",
"created_at": "2025-07-04T19:26:10.013Z",
"updated_at": "2025-07-04T19:26:10.013Z",
"advanceStatus": "text",
"due_notified": 1,
"user": {},
"process": {},
"process_request": {}
}
Last updated