Requests
API Reference for ProcessMaker Request 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.
Only return requests by type (all|in_progress|completed)
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.
""
GET /api/1.0/requests HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
list of processes
{
"data": [
{
"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-07-04T19:26:10.013Z",
"updated_at": "2025-07-04T19:26:10.013Z",
"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-07-04T19:26:10.013Z",
"updated_at": "2025-07-04T19:26:10.013Z"
}
],
"birthdate": "2025-07-04",
"delegation_user_id": "text",
"manager_id": "text",
"meta": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"force_change_password": true,
"id": 1,
"created_at": "2025-07-04T19:26:10.013Z",
"updated_at": "2025-07-04T19:26:10.013Z",
"deleted_at": "2025-07-04T19:26:10.013Z"
}
]
}
],
"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.
ID of process request to return
Include data from related models in payload. Comma separated list.
""
GET /api/1.0/requests/{process_request_id} HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
"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-07-04T19:26:10.013Z",
"updated_at": "2025-07-04T19:26:10.013Z",
"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-07-04T19:26:10.013Z",
"updated_at": "2025-07-04T19:26:10.013Z"
}
],
"birthdate": "2025-07-04",
"delegation_user_id": "text",
"manager_id": "text",
"meta": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"force_change_password": true,
"id": 1,
"created_at": "2025-07-04T19:26:10.013Z",
"updated_at": "2025-07-04T19:26:10.013Z",
"deleted_at": "2025-07-04T19:26:10.013Z"
}
]
}
Update a request
ID of process request to return
Represents an Eloquent model of a Request which is an instance of a Process.
PUT /api/1.0/requests/{process_request_id} HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 109
{
"user_id": "text",
"callable_id": "text",
"data": {},
"status": "ACTIVE",
"name": "text",
"process_id": 1,
"process": {}
}
No content
Delete a request
ID of process request to return
DELETE /api/1.0/requests/{process_request_id} HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
"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-07-04T19:26:10.013Z",
"updated_at": "2025-07-04T19:26:10.013Z",
"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-07-04T19:26:10.013Z",
"updated_at": "2025-07-04T19:26:10.013Z"
}
],
"birthdate": "2025-07-04",
"delegation_user_id": "text",
"manager_id": "text",
"meta": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"force_change_password": true,
"id": 1,
"created_at": "2025-07-04T19:26:10.013Z",
"updated_at": "2025-07-04T19:26:10.013Z",
"deleted_at": "2025-07-04T19:26:10.013Z"
}
]
}
Trigger a intermediate catch event
ID of process request to return
ID of process event to return
POST /api/1.0/requests/{process_request_id}/events/{event_id} HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
success
No content
Display a listing of the resource.
ID of the request
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/requests/{request_id}/files HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
list of files
{
"data": [
{
"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-07-04T19:26:10.013Z",
"updated_at": "2025-07-04T19:26:10.013Z"
}
],
"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.
ID of the request
Variable name in the request data to use for the file name
save a new media file
POST /api/1.0/requests/{request_id}/files HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 17
{
"file": "binary"
}
success
{
"message": "text",
"fileUploadId": 1
}
Display the specified resource.
ID of the request
ID of the file to return
GET /api/1.0/requests/{request_id}/files/{file_id} HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
binary
Remove the specified resource from storage.
ID of the file
ID of the request
DELETE /api/1.0/requests/{request_id}/files/{file_id} HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
No content
Last updated