Processes

API Reference for ProcessMaker Process API

Returns all processes categories that the user has access to

Display a listing of the Process Categories.

get

/process_categories

Authorizations

passportbearer

Query parameters

filterstring

Filter results by string. Searches Name and Status. All fields must match exactly.

order_bystring

Field to order results by

order_directionstring · enum · default: asc

Options: asc, desc

per_pageinteger · default: 10

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/1.0/process_categories'

200

200

{
  "meta": {},
  "data": [
    {
      "name": "text",
      "status": "ACTIVE",
      "id": "text",
      "created_at": "2025-02-20T19:09:27.112Z",
      "updated_at": "2025-02-20T19:09:27.112Z"
    }
  ]
}

list of processes categories

Save a new process Category

Store a newly created Process Category in storage

post

/process_categories

Authorizations

passportbearer

Body

namestring

Represents a business process category definition.

statusstring · enum

Options: ACTIVE, INACTIVE

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/1.0/process_categories' \
  --header 'Content-Type: application/json' \
  --data '{"status":"ACTIVE"}'

201

201

{
  "name": "text",
  "status": "ACTIVE",
  "id": "text",
  "created_at": "2025-02-20T19:09:27.112Z",
  "updated_at": "2025-02-20T19:09:27.112Z"
}

success

Get single process category by ID

Display the specified Process category.

get

/process_categories/{process_category_id}

Authorizations

passportbearer

Path parameters

process_category_idintegerrequired

ID of process category to return

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/1.0/process_categories/{process_category_id}'

200

200

{
  "name": "text",
  "status": "ACTIVE",
  "id": "text",
  "created_at": "2025-02-20T19:09:27.112Z",
  "updated_at": "2025-02-20T19:09:27.112Z"
}

Successfully found the process

Update a process Category

Updates the current element

put

/process_categories/{process_category_id}

Authorizations

passportbearer

Path parameters

process_category_idintegerrequired

ID of process category to return

Body

namestring

Represents a business process category definition.

statusstring · enum

Options: ACTIVE, INACTIVE

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/api/1.0/process_categories/{process_category_id}' \
  --header 'Content-Type: application/json' \
  --data '{"status":"ACTIVE"}'

200

200

{
  "name": "text",
  "status": "ACTIVE",
  "id": "text",
  "created_at": "2025-02-20T19:09:27.112Z",
  "updated_at": "2025-02-20T19:09:27.112Z"
}

success

Delete a process category

Remove the specified resource from storage.

delete

/process_categories/{process_category_id}

Authorizations

passportbearer

Path parameters

process_category_idintegerrequired

ID of process category to return

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/api/1.0/process_categories/{process_category_id}'

204

204

{
  "process_category_id": 1,
  "name": "text",
  "description": "text",
  "pause_timer_start": 1,
  "cancel_screen_id": 1,
  "has_timer_start_events": true,
  "request_detail_screen_id": 1,
  "is_valid": 1,
  "package_key": "text",
  "warnings": "text",
  "self_service_tasks": {},
  "category": {},
  "manager_id": 1,
  "status": "ACTIVE",
  "start_events": [
    {
      "eventDefinitions": {},
      "parallelMultiple": true,
      "outgoing": {},
      "incoming": {},
      "id": "text",
      "name": "text"
    }
  ],
  "signal_events": [
    {}
  ],
  "user_id": 1,
  "id": "text",
  "deleted_at": "2025-02-20T19:09:27.112Z",
  "created_at": "2025-02-20T19:09:27.112Z",
  "updated_at": "2025-02-20T19:09:27.112Z",
  "notifications": {},
  "task_notifications": {}
}

success

Returns all processes that the user has access to

Get list Process

get

/processes

Authorizations

passportbearer

Query parameters

filterstring

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

order_bystring

Field to order results by

order_directionstring · enum · default: asc

Options: asc, desc

per_pageinteger · default: 10

statusstring · enum

ACTIVE or INACTIVE

Options: ACTIVE, INACTIVE

includestring

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

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/1.0/processes'

200

200

{
  "meta": {
    "filter": "text",
    "sort_by": "text",
    "count": 1,
    "total_pages": 1,
    "current_page": 1,
    "form": 1,
    "last_page": 1,
    "path": "text",
    "per_page": 1,
    "to": 1,
    "total": 1,
    "sort_order": "asc"
  },
  "data": [
    {
      "process_category_id": 1,
      "name": "text",
      "description": "text",
      "pause_timer_start": 1,
      "cancel_screen_id": 1,
      "has_timer_start_events": true,
      "request_detail_screen_id": 1,
      "is_valid": 1,
      "package_key": "text",
      "warnings": "text",
      "self_service_tasks": {},
      "category": {},
      "manager_id": 1,
      "status": "ACTIVE",
      "start_events": [
        {
          "eventDefinitions": {},
          "parallelMultiple": true,
          "outgoing": {},
          "incoming": {},
          "id": "text",
          "name": "text"
        }
      ],
      "signal_events": [
        {}
      ],
      "user_id": 1,
      "id": "text",
      "deleted_at": "2025-02-20T19:09:27.112Z",
      "created_at": "2025-02-20T19:09:27.112Z",
      "updated_at": "2025-02-20T19:09:27.112Z",
      "notifications": {},
      "task_notifications": {}
    }
  ]
}

list of processes

Save a new process

Store a newly created resource in storage.

post

/processes

Authorizations

passportbearer

Body

process_category_idinteger · id

Represents a business process definition.

namestring

descriptionstring

pause_timer_startinteger

cancel_screen_idinteger

has_timer_start_eventsboolean

request_detail_screen_idinteger · id

is_validinteger

package_keystring

warningsstring

self_service_tasksobject

categoryobject

manager_idinteger · id

statusstring · enum

Options: ACTIVE, INACTIVE, ARCHIVED

start_eventsobject[]

signal_eventsobject[]

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/1.0/processes' \
  --header 'Content-Type: application/json' \
  --data '{"self_service_tasks":{},"category":{},"status":"ACTIVE","start_events":[{"eventDefinitions":{},"parallelMultiple":true,"outgoing":{},"incoming":{},"id":"text","name":"text"}],"signal_events":[{}]}'

201

201

{
  "process_category_id": 1,
  "name": "text",
  "description": "text",
  "pause_timer_start": 1,
  "cancel_screen_id": 1,
  "has_timer_start_events": true,
  "request_detail_screen_id": 1,
  "is_valid": 1,
  "package_key": "text",
  "warnings": "text",
  "self_service_tasks": {},
  "category": {},
  "manager_id": 1,
  "status": "ACTIVE",
  "start_events": [
    {
      "eventDefinitions": {},
      "parallelMultiple": true,
      "outgoing": {},
      "incoming": {},
      "id": "text",
      "name": "text"
    }
  ],
  "signal_events": [
    {}
  ],
  "user_id": 1,
  "id": "text",
  "deleted_at": "2025-02-20T19:09:27.112Z",
  "created_at": "2025-02-20T19:09:27.112Z",
  "updated_at": "2025-02-20T19:09:27.112Z",
  "notifications": {},
  "task_notifications": {}
}

success

Get single process by ID

Display the specified resource.

get

/processes/{processId}

Authorizations

passportbearer

Path parameters

processIdintegerrequired

ID of process to return

Query parameters

includestring

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

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/1.0/processes/{processId}'

200

200

{
  "process_category_id": 1,
  "name": "text",
  "description": "text",
  "pause_timer_start": 1,
  "cancel_screen_id": 1,
  "has_timer_start_events": true,
  "request_detail_screen_id": 1,
  "is_valid": 1,
  "package_key": "text",
  "warnings": "text",
  "self_service_tasks": {},
  "category": {},
  "manager_id": 1,
  "status": "ACTIVE",
  "start_events": [
    {
      "eventDefinitions": {},
      "parallelMultiple": true,
      "outgoing": {},
      "incoming": {},
      "id": "text",
      "name": "text"
    }
  ],
  "signal_events": [
    {}
  ],
  "user_id": 1,
  "id": "text",
  "deleted_at": "2025-02-20T19:09:27.112Z",
  "created_at": "2025-02-20T19:09:27.112Z",
  "updated_at": "2025-02-20T19:09:27.112Z",
  "notifications": {},
  "task_notifications": {}
}

Successfully found the process

Update a process

Updates the current element.

put

/processes/{processId}

Authorizations

passportbearer

Path parameters

processIdintegerrequired

ID of process to return

Body

process_category_idinteger · id

Represents a business process definition.

namestring

descriptionstring

pause_timer_startinteger

cancel_screen_idinteger

has_timer_start_eventsboolean

request_detail_screen_idinteger · id

is_validinteger

package_keystring

warningsstring

self_service_tasksobject

categoryobject

manager_idinteger · id

statusstring · enum

Options: ACTIVE, INACTIVE, ARCHIVED

start_eventsobject[]

signal_eventsobject[]

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/api/1.0/processes/{processId}' \
  --header 'Content-Type: application/json' \
  --data '{"self_service_tasks":{},"category":{},"status":"ACTIVE","start_events":[{"eventDefinitions":{},"parallelMultiple":true,"outgoing":{},"incoming":{},"id":"text","name":"text"}],"signal_events":[{}]}'

200

200

{
  "process_category_id": 1,
  "name": "text",
  "description": "text",
  "pause_timer_start": 1,
  "cancel_screen_id": 1,
  "has_timer_start_events": true,
  "request_detail_screen_id": 1,
  "is_valid": 1,
  "package_key": "text",
  "warnings": "text",
  "self_service_tasks": {},
  "category": {},
  "manager_id": 1,
  "status": "ACTIVE",
  "start_events": [
    {
      "eventDefinitions": {},
      "parallelMultiple": true,
      "outgoing": {},
      "incoming": {},
      "id": "text",
      "name": "text"
    }
  ],
  "signal_events": [
    {}
  ],
  "user_id": 1,
  "id": "text",
  "deleted_at": "2025-02-20T19:09:27.112Z",
  "created_at": "2025-02-20T19:09:27.112Z",
  "updated_at": "2025-02-20T19:09:27.112Z",
  "notifications": {},
  "task_notifications": {}
}

success

Delete a process

Remove the specified resource from storage.

delete

/processes/{processId}

Authorizations

passportbearer

Path parameters

processIdintegerrequired

ID of process to return

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/api/1.0/processes/{processId}'

204

204

No body

success

Returns the list of processes that the user can start

Returns the list of processes that the user can start.

get

/start_processes

Authorizations

passportbearer

Path parameters

without_event_definitionsboolean

If true return only processes that haven't start event definitions

Query parameters

filterstring

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

order_bystring

Field to order results by

order_directionstring · enum · default: asc

Options: asc, desc

per_pageinteger · default: 10

includestring

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

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/1.0/start_processes'

200

200

{
  "meta": {
    "filter": "text",
    "sort_by": "text",
    "count": 1,
    "total_pages": 1,
    "current_page": 1,
    "form": 1,
    "last_page": 1,
    "path": "text",
    "per_page": 1,
    "to": 1,
    "total": 1,
    "sort_order": "asc"
  },
  "data": [
    {
      "process_category_id": 1,
      "name": "text",
      "description": "text",
      "pause_timer_start": 1,
      "cancel_screen_id": 1,
      "has_timer_start_events": true,
      "request_detail_screen_id": 1,
      "is_valid": 1,
      "package_key": "text",
      "warnings": "text",
      "self_service_tasks": {},
      "category": {},
      "manager_id": 1,
      "status": "ACTIVE",
      "start_events": [
        {
          "eventDefinitions": {},
          "parallelMultiple": true,
          "outgoing": {},
          "incoming": {},
          "id": "text",
          "name": "text"
        }
      ],
      "signal_events": [
        {}
      ],
      "user_id": 1,
      "id": "text",
      "deleted_at": "2025-02-20T19:09:27.112Z",
      "created_at": "2025-02-20T19:09:27.112Z",
      "updated_at": "2025-02-20T19:09:27.112Z",
      "notifications": {},
      "task_notifications": {}
    },
    {
      "events": [
        {
          "eventDefinitions": {},
          "parallelMultiple": true,
          "outgoing": {},
          "incoming": {},
          "id": "text",
          "name": "text"
        }
      ]
    }
  ]
}

list of processes that the user can start

Restore an inactive process

Reverses the soft delete of the element.

put

/processes/{processId}/restore

Authorizations

passportbearer

Path parameters

processIdintegerrequired

ID of process to return

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/api/1.0/processes/{processId}/restore'

200

200

{
  "process_category_id": 1,
  "name": "text",
  "description": "text",
  "pause_timer_start": 1,
  "cancel_screen_id": 1,
  "has_timer_start_events": true,
  "request_detail_screen_id": 1,
  "is_valid": 1,
  "package_key": "text",
  "warnings": "text",
  "self_service_tasks": {},
  "category": {},
  "manager_id": 1,
  "status": "ACTIVE",
  "start_events": [
    {
      "eventDefinitions": {},
      "parallelMultiple": true,
      "outgoing": {},
      "incoming": {},
      "id": "text",
      "name": "text"
    }
  ],
  "signal_events": [
    {}
  ],
  "user_id": 1,
  "id": "text",
  "deleted_at": "2025-02-20T19:09:27.112Z",
  "created_at": "2025-02-20T19:09:27.112Z",
  "updated_at": "2025-02-20T19:09:27.112Z",
  "notifications": {},
  "task_notifications": {}
}

success

Export a single process by ID and return a URL to download it

Export the specified process.

post

/processes/{processId}/export

Authorizations

passportbearer

Path parameters

processIdintegerrequired

ID of process to export

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/1.0/processes/{processId}/export'

200

200

{
  "url": "text"
}

Successfully built the process for export

Validate a import

Validate the specified process before importing.

post

/processes/import/validation

Authorizations

passportbearer

Body

filestring · binary

file to import

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/1.0/processes/import/validation' \
  --header 'Content-Type: multipart/form-data'

200

200

{
  "process_category_id": 1,
  "name": "text",
  "description": "text",
  "pause_timer_start": 1,
  "cancel_screen_id": 1,
  "has_timer_start_events": true,
  "request_detail_screen_id": 1,
  "is_valid": 1,
  "package_key": "text",
  "warnings": "text",
  "self_service_tasks": {},
  "category": {},
  "manager_id": 1,
  "status": [
    {}
  ],
  "start_events": [
    {
      "eventDefinitions": {},
      "parallelMultiple": true,
      "outgoing": {},
      "incoming": {},
      "id": "text",
      "name": "text"
    }
  ],
  "signal_events": [
    {}
  ],
  "process": null,
  "assignable": [
    {}
  ]
}

success

Import a new process

Import the specified process.

post

/processes/import

Authorizations

passportbearer

Body

filestring · binary

file to import

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/1.0/processes/import' \
  --header 'Content-Type: multipart/form-data'

200

200

{
  "process_category_id": 1,
  "name": "text",
  "description": "text",
  "pause_timer_start": 1,
  "cancel_screen_id": 1,
  "has_timer_start_events": true,
  "request_detail_screen_id": 1,
  "is_valid": 1,
  "package_key": "text",
  "warnings": "text",
  "self_service_tasks": {},
  "category": {},
  "manager_id": 1,
  "status": [
    {}
  ],
  "start_events": [
    {
      "eventDefinitions": {},
      "parallelMultiple": true,
      "outgoing": {},
      "incoming": {},
      "id": "text",
      "name": "text"
    }
  ],
  "signal_events": [
    {}
  ],
  "process": null,
  "assignable": [
    {}
  ]
}

success

Check if the import is ready

Check if the import is ready

head

/processes/import/{code}/is_ready

Authorizations

passportbearer

Path parameters

codestringrequired

Import code

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request HEAD \
  --url '/api/1.0/processes/import/{code}/is_ready'

200

200

{
  "ready": true
}

check is import is ready

Update assignments after import

Import Assignments of process.

post

/processes/{process_id}/import/assignments

Authorizations

passportbearer

Path parameters

process_idintegerrequired

ID of process to return

Body

cancel_requestobject

edit_dataobject

assignableobject[]

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/1.0/processes/{process_id}/import/assignments' \
  --header 'Content-Type: application/json' \
  --data '{"cancel_request":{},"edit_data":{},"assignable":[{}]}'

204

204

No body

success

Start a new process

Trigger an start event within a process.

post

/process_events/{process_id}

Authorizations

passportbearer

Path parameters

process_idintegerrequired

ID of process to return

Query parameters

eventstringrequired

Node ID of the start event

Body

object

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/1.0/process_events/{process_id}?event=text' \
  --header 'Content-Type: application/json'

200

200

{
  "user_id": "text",
  "callable_id": "text",
  "data": {},
  "name": "text",
  "process_id": "text",
  "process": {},
  "status": "ACTIVE",
  "user": null,
  "id": "text",
  "process_collaboration_id": "text",
  "participant_id": "text",
  "process_category_id": "text",
  "created_at": "2025-02-20T19:09:27.112Z",
  "updated_at": "2025-02-20T19:09:27.112Z",
  "participants": [
    {
      "email": "[e-mail]",
      "firstname": "text",
      "lastname": "text",
      "username": "text",
      "password": "text",
      "address": "text",
      "city": "text",
      "state": "text",
      "postal": "text",
      "country": "text",
      "phone": "text",
      "fax": "text",
      "cell": "text",
      "title": "text",
      "timezone": "text",
      "datetime_format": "text",
      "language": "text",
      "is_administrator": true,
      "expires_at": "text",
      "loggedin_at": "text",
      "remember_token": "text",
      "fullname": "text",
      "avatar": "text",
      "birthdate": "2025-02-20",
      "delegation_user_id": "text",
      "manager_id": "text",
      "meta": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "force_change_password": true,
      "status": "ACTIVE",
      "media": [
        {
          "id": 1,
          "model_id": 1,
          "model_type": "text",
          "collection_name": "text",
          "name": "text",
          "file_name": "text",
          "mime_type": "text",
          "disk": "text",
          "size": 1,
          "manipulations": {},
          "custom_properties": {},
          "responsive_images": {},
          "order_column": 1,
          "created_at": "2025-02-20T19:09:27.112Z",
          "updated_at": "2025-02-20T19:09:27.112Z"
        }
      ],
      "id": 1,
      "created_at": "2025-02-20T19:09:27.112Z",
      "updated_at": "2025-02-20T19:09:27.112Z",
      "deleted_at": "2025-02-20T19:09:27.112Z"
    }
  ]
}

success