processmaker.com Knowledge Center ProcessMaker University

Tasks

API Reference for ProcessMaker Task API

PreviousRequests NextProcesses

Last updated 4 months ago

Returns all tasks that the user has access to

get

Display a listing of the resource.

Authorizations

Query parameters

process_request_idintegerOptional

Process request id

filterstringOptional

Filter results by string. Searches Name, Description, and Status. Status must match exactly. Others can be a substring.

order_bystringOptional

Field to order results by

order_directionstring · enumOptionalDefault: ascPossible values:

includestringOptional

Include data from related models in payload. Comma separated list.

Default: ""

Responses

200

list of tasks

application/json

get

GET /api/1.0/tasks HTTP/1.1
Host: 
Accept: */*

200

list of tasks

{
  "data": [
    {
      "user_id": "text",
      "status": "text",
      "due_at": "2025-05-01T05:35:21.917Z",
      "initiated_at": "2025-05-01T05:35:21.917Z",
      "riskchanges_at": "2025-05-01T05:35:21.917Z",
      "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-05-01T05:35:21.917Z",
      "updated_at": "2025-05-01T05:35:21.917Z",
      "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
  }
}

Get a single task by ID

get

Display the specified resource.

Authorizations

Path parameters

task_idintegerRequired

task id

Query parameters

includestringOptional

include

Responses

200

success

application/json

Responseall of

404

Not Found

application/json

get

GET /api/1.0/tasks/{task_id} HTTP/1.1
Host: 
Accept: */*

{
  "user_id": "text",
  "status": "text",
  "due_at": "2025-05-01T05:35:21.917Z",
  "initiated_at": "2025-05-01T05:35:21.917Z",
  "riskchanges_at": "2025-05-01T05:35:21.917Z",
  "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-05-01T05:35:21.917Z",
  "updated_at": "2025-05-01T05:35:21.917Z",
  "advanceStatus": "text",
  "due_notified": 1,
  "user": {},
  "process": {},
  "process_request": {}
}

Returns all task assignments

get

Display a listing of the resource.

Authorizations

Query parameters

filterstringOptional

Filter results by string. Searches Name, Description, and Status. Status must match exactly. Others can be a substring.

order_bystringOptional

Field to order results by

order_directionstring · enumOptionalDefault: ascPossible values:

per_pageintegerOptionalDefault: 10

Responses

200

list of task assignments

application/json

get

GET /api/1.0/task_assignments HTTP/1.1
Host: 
Accept: */*

200

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-05-01T05:35:21.917Z",
      "updated_at": "2025-05-01T05:35:21.917Z"
    }
  ],
  "meta": {}
}

Create or update a new setting

post

Create a new Settings css-override

Authorizations

Body

variablesstringOptional

sansSerifFontstringOptional

Responses

201

success

application/json

Responseall of

post

POST /api/1.0/customize-ui HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 43

{
  "variables": "text",
  "sansSerifFont": "text"
}

201

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-05-01T05:35:21.917Z",
  "updated_at": "2025-05-01T05:35:21.917Z"
}

Save a new Task Assignment

post

Store a newly created task assignment in storage.

Authorizations

Body

process_idinteger · idOptional

Represents a business process task assignment definition.

process_task_idstring · idOptional

assignment_idinteger · idOptional

assignment_typestring · enumOptionalPossible values:

Responses

201

success

application/json

Responseall of

and

422

Unprocessable Entity

application/json

post

POST /api/1.0/task_assignments HTTP/1.1
Host: 
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-05-01T05:35:21.917Z",
  "updated_at": "2025-05-01T05:35:21.917Z"
}

Update a Task Assignment

put

Update a task assignment

Authorizations

Path parameters

task_assignmentintegerRequired

ID of task assignment to update

Body

process_idinteger · idOptional

Represents a business process task assignment definition.

process_task_idstring · idOptional

assignment_idinteger · idOptional

assignment_typestring · enumOptionalPossible values:

Responses

204

success

404

Not Found

application/json

422

Unprocessable Entity

application/json

put

PUT /api/1.0/task_assignments/{task_assignment} HTTP/1.1
Host: 
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

Delete a Task Assignment

delete

Remove an assignment

Authorizations

Path parameters

task_assignmentintegerRequired

ID of task assignment to delete

Body

process_idinteger · idOptional

Represents a business process task assignment definition.

process_task_idstring · idOptional

assignment_idinteger · idOptional

assignment_typestring · enumOptionalPossible values:

Responses

200

success

delete

DELETE /api/1.0/task_assignments/{task_assignment} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 106

{
  "process_id": 1,
  "process_task_id": "text",
  "assignment_id": 1,
  "assignment_type": "ProcessMaker\\Models\\User"
}

200

success

No content

Update a task

put

Updates the current element

Authorizations

Path parameters

task_idintegerRequired

ID of task to update

Body

statusstringRequiredExample: COMPLETED

dataobjectRequired

Responses

200

success

application/json

Responseall of

404

Not Found

application/json

422

Unprocessable Entity

application/json

put

PUT /api/1.0/tasks/{task_id} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 32

{
  "status": "COMPLETED",
  "data": {}
}

{
  "user_id": "text",
  "status": "text",
  "due_at": "2025-05-01T05:35:21.917Z",
  "initiated_at": "2025-05-01T05:35:21.917Z",
  "riskchanges_at": "2025-05-01T05:35:21.917Z",
  "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-05-01T05:35:21.917Z",
  "updated_at": "2025-05-01T05:35:21.917Z",
  "advanceStatus": "text",
  "due_notified": 1,
  "user": {},
  "process": {},
  "process_request": {}
}