Processes
API Reference for ProcessMaker Process API
Display a listing of the Process Categories.
Filter results by string. Searches Name and Status. All fields must match exactly.
Field to order results by
asc
Possible values: 10
list of processes categories
GET /api/1.0/process_categories HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
list of processes categories
{
"data": [
{
"name": "text",
"status": "ACTIVE",
"id": "text",
"created_at": "2025-08-12T03:52:15.040Z",
"updated_at": "2025-08-12T03:52:15.040Z"
}
],
"meta": {}
}
Store a newly created Process Category in storage
Represents a business process category definition.
success
POST /api/1.0/process_categories HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 33
{
"name": "text",
"status": "ACTIVE"
}
success
{
"name": "text",
"status": "ACTIVE",
"id": "text",
"created_at": "2025-08-12T03:52:15.040Z",
"updated_at": "2025-08-12T03:52:15.040Z"
}
Display the specified Process category.
ID of process category to return
Successfully found the process
GET /api/1.0/process_categories/{process_category_id} HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
Successfully found the process
{
"name": "text",
"status": "ACTIVE",
"id": "text",
"created_at": "2025-08-12T03:52:15.040Z",
"updated_at": "2025-08-12T03:52:15.040Z"
}
Updates the current element
ID of process category to return
Represents a business process category definition.
success
PUT /api/1.0/process_categories/{process_category_id} HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 33
{
"name": "text",
"status": "ACTIVE"
}
success
{
"name": "text",
"status": "ACTIVE",
"id": "text",
"created_at": "2025-08-12T03:52:15.040Z",
"updated_at": "2025-08-12T03:52:15.040Z"
}
Remove the specified resource from storage.
ID of process category to return
success
DELETE /api/1.0/process_categories/{process_category_id} HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
success
{
"process_category_id": 1,
"name": "text",
"description": "text",
"status": "ACTIVE",
"pause_timer_start": 1,
"cancel_screen_id": 1,
"has_timer_start_events": true,
"request_detail_screen_id": 1,
"is_valid": 1,
"package_key": "text",
"start_events": [
{
"eventDefinitions": {},
"parallelMultiple": true,
"outgoing": {},
"incoming": {},
"id": "text",
"name": "text"
}
],
"warnings": "text",
"self_service_tasks": {},
"signal_events": [
{}
],
"category": {},
"manager_id": 1,
"user_id": 1,
"id": "text",
"deleted_at": "2025-08-12T03:52:15.040Z",
"created_at": "2025-08-12T03:52:15.040Z",
"updated_at": "2025-08-12T03:52:15.040Z",
"notifications": {},
"task_notifications": {}
}
Get list Process
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
ACTIVE or INACTIVE
Include data from related models in payload. Comma separated list.
""
list of processes
GET /api/1.0/processes HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
list of processes
{
"data": [
{
"process_category_id": 1,
"name": "text",
"description": "text",
"status": "ACTIVE",
"pause_timer_start": 1,
"cancel_screen_id": 1,
"has_timer_start_events": true,
"request_detail_screen_id": 1,
"is_valid": 1,
"package_key": "text",
"start_events": [
{
"eventDefinitions": {},
"parallelMultiple": true,
"outgoing": {},
"incoming": {},
"id": "text",
"name": "text"
}
],
"warnings": "text",
"self_service_tasks": {},
"signal_events": [
{}
],
"category": {},
"manager_id": 1,
"user_id": 1,
"id": "text",
"deleted_at": "2025-08-12T03:52:15.040Z",
"created_at": "2025-08-12T03:52:15.040Z",
"updated_at": "2025-08-12T03:52:15.040Z",
"notifications": {},
"task_notifications": {}
}
],
"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
}
}
Store a newly created resource in storage.
Represents a business process definition.
success
POST /api/1.0/processes HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 425
{
"process_category_id": 1,
"name": "text",
"description": "text",
"status": "ACTIVE",
"pause_timer_start": 1,
"cancel_screen_id": 1,
"has_timer_start_events": true,
"request_detail_screen_id": 1,
"is_valid": 1,
"package_key": "text",
"start_events": [
{
"eventDefinitions": {},
"parallelMultiple": true,
"outgoing": {},
"incoming": {},
"id": "text",
"name": "text"
}
],
"warnings": "text",
"self_service_tasks": {},
"signal_events": [
{}
],
"category": {},
"manager_id": 1
}
success
{
"process_category_id": 1,
"name": "text",
"description": "text",
"status": "ACTIVE",
"pause_timer_start": 1,
"cancel_screen_id": 1,
"has_timer_start_events": true,
"request_detail_screen_id": 1,
"is_valid": 1,
"package_key": "text",
"start_events": [
{
"eventDefinitions": {},
"parallelMultiple": true,
"outgoing": {},
"incoming": {},
"id": "text",
"name": "text"
}
],
"warnings": "text",
"self_service_tasks": {},
"signal_events": [
{}
],
"category": {},
"manager_id": 1,
"user_id": 1,
"id": "text",
"deleted_at": "2025-08-12T03:52:15.040Z",
"created_at": "2025-08-12T03:52:15.040Z",
"updated_at": "2025-08-12T03:52:15.040Z",
"notifications": {},
"task_notifications": {}
}
Display the specified resource.
ID of process to return
Include data from related models in payload. Comma separated list.
""
Successfully found the process
GET /api/1.0/processes/{processId} HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
Successfully found the process
{
"process_category_id": 1,
"name": "text",
"description": "text",
"status": "ACTIVE",
"pause_timer_start": 1,
"cancel_screen_id": 1,
"has_timer_start_events": true,
"request_detail_screen_id": 1,
"is_valid": 1,
"package_key": "text",
"start_events": [
{
"eventDefinitions": {},
"parallelMultiple": true,
"outgoing": {},
"incoming": {},
"id": "text",
"name": "text"
}
],
"warnings": "text",
"self_service_tasks": {},
"signal_events": [
{}
],
"category": {},
"manager_id": 1,
"user_id": 1,
"id": "text",
"deleted_at": "2025-08-12T03:52:15.040Z",
"created_at": "2025-08-12T03:52:15.040Z",
"updated_at": "2025-08-12T03:52:15.040Z",
"notifications": {},
"task_notifications": {}
}
Updates the current element.
ID of process to return
Represents a business process definition.
success
PUT /api/1.0/processes/{processId} HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 425
{
"process_category_id": 1,
"name": "text",
"description": "text",
"status": "ACTIVE",
"pause_timer_start": 1,
"cancel_screen_id": 1,
"has_timer_start_events": true,
"request_detail_screen_id": 1,
"is_valid": 1,
"package_key": "text",
"start_events": [
{
"eventDefinitions": {},
"parallelMultiple": true,
"outgoing": {},
"incoming": {},
"id": "text",
"name": "text"
}
],
"warnings": "text",
"self_service_tasks": {},
"signal_events": [
{}
],
"category": {},
"manager_id": 1
}
success
{
"process_category_id": 1,
"name": "text",
"description": "text",
"status": "ACTIVE",
"pause_timer_start": 1,
"cancel_screen_id": 1,
"has_timer_start_events": true,
"request_detail_screen_id": 1,
"is_valid": 1,
"package_key": "text",
"start_events": [
{
"eventDefinitions": {},
"parallelMultiple": true,
"outgoing": {},
"incoming": {},
"id": "text",
"name": "text"
}
],
"warnings": "text",
"self_service_tasks": {},
"signal_events": [
{}
],
"category": {},
"manager_id": 1,
"user_id": 1,
"id": "text",
"deleted_at": "2025-08-12T03:52:15.040Z",
"created_at": "2025-08-12T03:52:15.040Z",
"updated_at": "2025-08-12T03:52:15.040Z",
"notifications": {},
"task_notifications": {}
}
Returns the list of processes that the user can start.
If true return only processes that haven't start event definitions
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
Include data from related models in payload. Comma separated list.
""
list of processes that the user can start
GET /api/1.0/start_processes HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
list of processes that the user can start
{
"data": [
{
"process_category_id": 1,
"name": "text",
"description": "text",
"status": "ACTIVE",
"pause_timer_start": 1,
"cancel_screen_id": 1,
"has_timer_start_events": true,
"request_detail_screen_id": 1,
"is_valid": 1,
"package_key": "text",
"start_events": [
{
"eventDefinitions": {},
"parallelMultiple": true,
"outgoing": {},
"incoming": {},
"id": "text",
"name": "text"
}
],
"warnings": "text",
"self_service_tasks": {},
"signal_events": [
{}
],
"category": {},
"manager_id": 1,
"user_id": 1,
"id": "text",
"deleted_at": "2025-08-12T03:52:15.040Z",
"created_at": "2025-08-12T03:52:15.040Z",
"updated_at": "2025-08-12T03:52:15.040Z",
"notifications": {},
"task_notifications": {}
},
{
"events": [
{
"eventDefinitions": {},
"parallelMultiple": true,
"outgoing": {},
"incoming": {},
"id": "text",
"name": "text"
}
]
}
],
"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
}
}
Reverses the soft delete of the element.
ID of process to return
success
PUT /api/1.0/processes/{processId}/restore HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
success
{
"process_category_id": 1,
"name": "text",
"description": "text",
"status": "ACTIVE",
"pause_timer_start": 1,
"cancel_screen_id": 1,
"has_timer_start_events": true,
"request_detail_screen_id": 1,
"is_valid": 1,
"package_key": "text",
"start_events": [
{
"eventDefinitions": {},
"parallelMultiple": true,
"outgoing": {},
"incoming": {},
"id": "text",
"name": "text"
}
],
"warnings": "text",
"self_service_tasks": {},
"signal_events": [
{}
],
"category": {},
"manager_id": 1,
"user_id": 1,
"id": "text",
"deleted_at": "2025-08-12T03:52:15.040Z",
"created_at": "2025-08-12T03:52:15.040Z",
"updated_at": "2025-08-12T03:52:15.040Z",
"notifications": {},
"task_notifications": {}
}
Export the specified process.
ID of process to export
Successfully built the process for export
POST /api/1.0/processes/{processId}/export HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
Successfully built the process for export
{
"url": "text"
}
Validate the specified process before importing.
file to import
success
POST /api/1.0/processes/import/validation HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 17
{
"file": "binary"
}
success
{
"process_category_id": 1,
"name": "text",
"description": "text",
"status": [
{}
],
"pause_timer_start": 1,
"cancel_screen_id": 1,
"has_timer_start_events": true,
"request_detail_screen_id": 1,
"is_valid": 1,
"package_key": "text",
"start_events": [
{
"eventDefinitions": {},
"parallelMultiple": true,
"outgoing": {},
"incoming": {},
"id": "text",
"name": "text"
}
],
"warnings": "text",
"self_service_tasks": {},
"signal_events": [
{}
],
"category": {},
"manager_id": 1,
"assignable": [
{}
],
"process": null
}
Import the specified process.
file to import
success
POST /api/1.0/processes/import HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 17
{
"file": "binary"
}
success
{
"process_category_id": 1,
"name": "text",
"description": "text",
"status": [
{}
],
"pause_timer_start": 1,
"cancel_screen_id": 1,
"has_timer_start_events": true,
"request_detail_screen_id": 1,
"is_valid": 1,
"package_key": "text",
"start_events": [
{
"eventDefinitions": {},
"parallelMultiple": true,
"outgoing": {},
"incoming": {},
"id": "text",
"name": "text"
}
],
"warnings": "text",
"self_service_tasks": {},
"signal_events": [
{}
],
"category": {},
"manager_id": 1,
"assignable": [
{}
],
"process": null
}
Check if the import is ready
Import code
check is import is ready
HEAD /api/1.0/processes/import/{code}/is_ready HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
check is import is ready
{
"ready": true
}
Import Assignments of process.
ID of process to return
success
POST /api/1.0/processes/{process_id}/import/assignments HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 54
{
"assignable": [
{}
],
"cancel_request": {},
"edit_data": {}
}
success
No content
Trigger an start event within a process.
ID of process to return
Node ID of the start event
success
POST /api/1.0/process_events/{process_id}?event=text HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 2
{}
success
{
"user_id": "text",
"callable_id": "text",
"data": {},
"status": "ACTIVE",
"name": "text",
"process_id": "text",
"process": {},
"id": "text",
"process_collaboration_id": "text",
"participant_id": "text",
"process_category_id": "text",
"created_at": "2025-08-12T03:52:15.040Z",
"updated_at": "2025-08-12T03:52:15.040Z",
"user": null,
"participants": [
{
"email": "name@gmail.com",
"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",
"status": "ACTIVE",
"fullname": "text",
"avatar": "text",
"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-08-12T03:52:15.040Z",
"updated_at": "2025-08-12T03:52:15.040Z"
}
],
"birthdate": "2025-08-12",
"delegation_user_id": "text",
"manager_id": "text",
"meta": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"force_change_password": true,
"id": 1,
"created_at": "2025-08-12T03:52:15.040Z",
"updated_at": "2025-08-12T03:52:15.040Z",
"deleted_at": "2025-08-12T03:52:15.040Z"
}
]
}
Last updated