1 of 22

API

ProcessMaker Platform API Documentation

ProcessMaker Platform RESTful API

Access the ProcessMaker Platform RESTful API documentation from your ProcessMaker Platform instance.

Overview

The ProcessMaker Platform user interface consumes our RESTful API, which is compliant with the OpenAPI specification. Administrators and developers may want to browse API documentation (automatically generated by Swagger) to understand how to use the available API endpoints or to consider how to extend ProcessMaker Platform functionality for their own use cases.

In order to use the ProcessMaker Platform API, you must know the base URL to your ProcessMaker Platform instance.

Example: https://MyOrganization.processmaker.net/

Test API Endpoints from the API Documentation

Follow these steps to test our RESTful API endpoints from the API documentation:

Open a new Web browser tab or window.
Append api/documentation to the end of your ProcessMaker Platform instance's base URL. Example: https://MyOrganization.processmaker.net/api/documentation. The API documentation displays.
Click the Expand operation icon for the ProcessMaker Platform API endpoint you want to test. Technical information about that API endpoint displays.
Click the Try it out button, and then enter parameters documented for that API endpoint into their appropriate fields.
Click Execute.

Make API Calls with the Data Connector

You may use a Data Connector to make requests (calls) with our API associated with your ProcessMaker Platform instance. See ProcessMaker Data Connectors.

Platform API Reference

Users

API Reference for ProcessMaker Users API

Groups

API Reference for ProcessMaker Group API

Requests

API Reference for ProcessMaker Request API

Tasks

API Reference for ProcessMaker Task API

Processes

API Reference for ProcessMaker Process API

Screens

API Reference for ProcessMaker Screen API

Environment Variables

API Reference for ProcessMaker Environment Variable API

Files

API Reference for ProcessMaker File API

Notifications

API Reference for ProcessMaker Notification API

Scripts

API Reference for ProcessMaker Script API

Administrative APIs

API Reference for ProcessMaker Administration APIs

Premium API Reference

Data Connectors

Collections

Decision Engine

Saved Search

Tools

ProcessMaker Platform RESTful API

Access the ProcessMaker Platform RESTful API documentation from your ProcessMaker Platform instance.

Overview

In order to use the ProcessMaker Platform API, you must know the base URL to your ProcessMaker Platform instance.

Example: https://MyOrganization.processmaker.net/

Test API Endpoints from the API Documentation

Follow these steps to test our RESTful API endpoints from the API documentation:

Open a new Web browser tab or window.
Append api/documentation to the end of your ProcessMaker Platform instance's base URL. Example: https://MyOrganization.processmaker.net/api/documentation. The API documentation displays.
Click the Expand operation icon for the ProcessMaker Platform API endpoint you want to test. Technical information about that API endpoint displays.
Click the Try it out button, and then enter parameters documented for that API endpoint into their appropriate fields.
Click Execute.

Make API Calls with the Data Connector

You may use a Data Connector to make requests (calls) with our API associated with your ProcessMaker Platform instance. See ProcessMaker Data Connectors.

Returns all environmentVariables that the user has access to. For security, values are not included.

get

Fetch a collection of variables based on paged request and filter if provided

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 · enum · default: "asc"optional

Available options:

per_pageinteger · default: "10"optional

includestring · default: ""optional

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

Responses

application/json

cURL

JavaScript

Python

HTTP

200

list of environmentVariables

Returns all processes that the user has access to

get

Get list Process

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 · enum · default: "asc"optional

Available options:

per_pageinteger · default: "10"optional

statusstring · enumoptional

ACTIVE or INACTIVE

Available options:

includestring · default: ""optional

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

Responses

application/json

cURL

JavaScript

Python

HTTP

200

list of processes

Returns the list of processes that the user can start

get

Returns the list of processes that the user can start.

Authorizations

Path parameters

without_event_definitionsbooleanoptional

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

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 · enum · default: "asc"optional

Available options:

per_pageinteger · default: "10"optional

includestring · default: ""optional

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

Responses

application/json

cURL

JavaScript

Python

HTTP

200

list of processes that the user can start

Returns all notifications that the user has access to

get

Display a listing of the resource.

Authorizations

Query parameters

statusstringoptional

Only return notifications by status (unread, all, etc.)

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 · enum · default: "asc"optional

Available options:

per_pageinteger · default: "10"optional

includestring · default: ""optional

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

Responses

application/json

cURL

JavaScript

Python

HTTP

200

list of notifications

Returns all screens that the user has access to

get

Get a list of Screens.

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 · enum · default: "asc"optional

Available options:

per_pageinteger · default: "10"optional

includestring · default: ""optional

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

excludestring · default: ""optional

Comma separated list of fields to exclude from the response

Responses

application/json

cURL

JavaScript

Python

HTTP

200

list of screens

Returns all scripts that the user has access to

get

Get a list of scripts in a process.

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 · enum · default: "asc"optional

Available options:

per_pageinteger · default: "10"optional

includestring · default: ""optional

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

Responses

application/json

cURL

JavaScript

Python

HTTP

200

list of scripts

Returns all users

get

Display a listing of the resource.

Authorizations

Query parameters

statusstring · enumoptional

ACTIVE or INACTIVE

Available options:

filterstringoptional

Filter results by string. Searches First Name, Last Name, Email and Username.

order_bystringoptional

Field to order results by

order_directionstring · enum · default: "asc"optional

Available options:

per_pageinteger · default: "10"optional

includestring · default: ""optional

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

exclude_idsstring · default: ""optional

Comma separated list of IDs to exclude from the response

Responses

application/json

cURL

JavaScript

Python

HTTP

200

list of users

Returns all groups that the user has access to

get

Display a listing of the resource.

Authorizations

Query parameters

statusstring · enumoptional

ACTIVE or INACTIVE

Available options:

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 · enum · default: "asc"optional

Available options:

per_pageinteger · default: "10"optional

includestring · default: ""optional

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

Responses

application/json

cURL

JavaScript

Python

HTTP

200

list of groups

Returns all groups available for a given member

get

Display a listing of groups available

Authorizations

Path parameters

member_idstringrequired

ID of group member to return

member_typestringrequired

type of group member to return

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 · enum · default: "asc"optional

Available options:

per_pageinteger · default: "10"optional

Responses

application/json

cURL

JavaScript

Python

HTTP

200

list of groups available to be assigned as member

Returns all users available for a given group

get

Display a listing of users available

Authorizations

Path parameters

group_idstringrequired

ID of group to return

Query parameters

filterstringoptional

Filter results by string. Searches Name. Can be a substring.

order_bystringoptional

Field to order results by

order_directionstring · enum · default: "asc"optional

Available options:

per_pageinteger · default: "10"optional

Responses

application/json

cURL

JavaScript

Python

HTTP

200

list of users available to be assigned as member

Returns all process Requests that the user has access to

get

Display a listing of the resource.

Authorizations

Query parameters

typestring · enumoptional

Only return requests by type (all|in_progress|completed)

Available options:

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 · enum · default: "asc"optional

Available options:

per_pageinteger · default: "10"optional

includestring · default: ""optional

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

Responses

application/json

cURL

JavaScript

Python

HTTP

200

list of processes

Returns the list of files associated with a request

get

Display a listing of the resource.

Authorizations

Path parameters

request_idintegerrequired

ID of the request

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 · enum · default: "asc"optional

Available options:

per_pageinteger · default: "10"optional

Responses

application/json

cURL

JavaScript

Python

HTTP

200

list of files

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 · enum · default: "asc"optional

Available options:

includestring · default: ""optional

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

Responses

application/json

cURL

JavaScript

Python

HTTP

200

list of tasks

Returns all Data Connectors categories that the user has access to

get

Display a listing of the Data Connector Categories.

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 · enum · default: "asc"optional

Available options:

per_pageinteger · default: "10"optional

Responses

application/json

cURL

JavaScript

Python

HTTP

200

list of Data Connectors categories

Returns all Data Connectors that the user has access to

get

Get the list of records of a Data Connector

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 · enum · default: "asc"optional

Available options:

per_pageinteger · default: "10"optional

includestring · default: ""optional

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

Responses

application/json

cURL

JavaScript

Python

HTTP

200

list of Data Connectors

Returns all saved search charts that the user has access to

get

Get a list of SavedSearchCharts.

Authorizations

Query parameters

filterstringoptional

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

typestring · enumoptional

Only return saved searches by type

Available options:

order_bystringoptional

Field to order results by

order_directionstring · enum · default: "asc"optional

Available options:

per_pageinteger · default: "10"optional

includestring · default: ""optional

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

Responses

application/json

cURL

JavaScript

Python

HTTP

200

list of saved search charts

Returns all saved searches that the user has access to

get

Get a list of SavedSearches.

Authorizations

Query parameters

filterstringoptional

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

typestring · enumoptional

Only return saved searches by type

Available options:

subsetstring · enumoptional

Only return saved searches that are yours or those that have been shared with you

Available options:

order_bystringoptional

Field to order results by

order_directionstring · enum · default: "asc"optional

Available options:

per_pageinteger · default: "10"optional

includestring · default: ""optional

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

Responses

application/json

cURL

JavaScript

Python

HTTP

200

list of saved searches

Returns all users

get

Display a listing of the resource.

Authorizations

Path parameters

savedSearchIdstringrequired

ID of saved search to return

Query parameters

filterstringoptional

Filter results by string. Searches First Name, Last Name, Email and Username.

order_bystringoptional

Field to order results by

order_directionstring · enum · default: "asc"optional

Available options:

per_pageinteger · default: "10"optional

includestring · default: ""optional

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

Responses

application/json

cURL

JavaScript

Python

HTTP

200

list of users

Returns all collections that the user has access to

get

Get a list of Collections.

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 · enum · default: "asc"optional

Available options:

per_pageinteger · default: "10"optional

includestring · default: ""optional

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

Responses

application/json

cURL

JavaScript

Python

HTTP

200

list of collections

Returns all records

get

Get the list of records of a collection.

Authorizations

Path parameters

collection_idstringrequired

ID of collection to get records for

Query parameters

pmqlstringoptional

per_pageinteger · default: "10"optional

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 · enum · default: "asc"optional

Available options:

includestring · default: ""optional

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

Responses

application/json

cURL

JavaScript

Python

HTTP

200

list of records of a collection

Create a new environment variable

post

Creates a new global Environment Variable in the system

Authorizations

Body

namestringoptional

descriptionstringoptional

valuestringoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/1.0/environment_variables' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "description": "text",
    "value": "text"
  }'

201

{
  "name": "text",
  "description": "text",
  "value": "text",
  "id": 1,
  "created_at": "2025-04-02T12:35:58.505Z",
  "updated_at": "2025-04-02T12:35:58.505Z"
}

success

Update an environment variable

put

Update an environment variable

Authorizations

Path parameters

environment_variable_idintegerrequired

ID of environment variables to update

Body

namestringoptional

descriptionstringoptional

valuestringoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/api/1.0/environment_variables/{environment_variable_id}' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "description": "text",
    "value": "text"
  }'

200

{
  "name": "text",
  "description": "text",
  "value": "text",
  "id": 1,
  "created_at": "2025-04-02T12:35:58.505Z",
  "updated_at": "2025-04-02T12:35:58.505Z"
}

success

Create or update a new setting

post

Create a new Settings css-override

Authorizations

Body

variablesstringoptional

sansSerifFontstringoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/1.0/customize-ui' \
  --header 'Content-Type: application/json' \
  --data '{
    "variables": "text",
    "sansSerifFont": "text"
  }'

201

{
  "key": "text",
  "config": [
    {}
  ],
  "name": "text",
  "helper": "text",
  "group": "text",
  "format": "text",
  "hidden": true,
  "readonly": true,
  "variables": "text",
  "sansSerifFont": "text",
  "id": "text",
  "created_at": "2025-04-02T12:35:58.505Z",
  "updated_at": "2025-04-02T12:35:58.505Z"
}

success

Save a new media file. Note: To upload files to a request, use createRequestFile in the RequestFile API

post

Store a newly created resource in storage.

Authorizations

Query parameters

model_idintegerrequired

ID of the model to which the file will be associated

modelstringrequired

Full namespaced class of the model to associate

data_namestringoptional

Name of the variable used in a request

collectionstringoptional

Media collection name. For requests, use 'default'

Body

filestring · binaryoptional

save a new media file

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/1.0/files?model_id=1&model=text' \
  --header 'Content-Type: multipart/form-data' \
  --form 'file=binary'

200

{
  "id": "text",
  "model_id": "text",
  "file_name": "text",
  "mime_type": "text"
}

success

Save a new process Category

post

Store a newly created Process Category in storage

Authorizations

Body

namestringoptional

Represents a business process category definition.

statusstring · enumoptional

Available options:

Responses

application/json

cURL

JavaScript

Python

HTTP

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

201

{
  "name": "text",
  "status": "ACTIVE",
  "id": "text",
  "created_at": "2025-04-02T12:35:58.505Z",
  "updated_at": "2025-04-02T12:35:58.505Z"
}

success

Update a process Category

put

Updates the current element

Authorizations

Path parameters

process_category_idintegerrequired

ID of process category to return

Body

namestringoptional

Represents a business process category definition.

statusstring · enumoptional

Available options:

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

{
  "name": "text",
  "status": "ACTIVE",
  "id": "text",
  "created_at": "2025-04-02T12:35:58.505Z",
  "updated_at": "2025-04-02T12:35:58.505Z"
}

success

{
  "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-04-02T12:35:58.505Z",
      "created_at": "2025-04-02T12:35:58.505Z",
      "updated_at": "2025-04-02T12:35:58.505Z",
      "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
  }
}

Save a new process

post

Store a newly created resource in storage.

Authorizations

Body

process_category_idinteger · idoptional

Represents a business process definition.

namestringoptional

descriptionstringoptional

statusstring · enumoptional

Available options:

pause_timer_startintegeroptional

cancel_screen_idintegeroptional

has_timer_start_eventsbooleanoptional

request_detail_screen_idinteger · idoptional

is_validintegeroptional

package_keystringoptional

start_eventsobject[]optional

warningsstringoptional

self_service_tasksobjectoptional

signal_eventsobject[]optional

categoryobjectoptional

manager_idinteger · idoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/1.0/processes' \
  --header 'Content-Type: application/json' \
  --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
  }'

201

{
  "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-04-02T12:35:58.505Z",
  "created_at": "2025-04-02T12:35:58.505Z",
  "updated_at": "2025-04-02T12:35:58.505Z",
  "notifications": {},
  "task_notifications": {}
}

success

Update a process

put

Updates the current element.

Authorizations

Path parameters

processIdintegerrequired

ID of process to return

Body

process_category_idinteger · idoptional

Represents a business process definition.

namestringoptional

descriptionstringoptional

statusstring · enumoptional

Available options:

pause_timer_startintegeroptional

cancel_screen_idintegeroptional

has_timer_start_eventsbooleanoptional

request_detail_screen_idinteger · idoptional

is_validintegeroptional

package_keystringoptional

start_eventsobject[]optional

warningsstringoptional

self_service_tasksobjectoptional

signal_eventsobject[]optional

categoryobjectoptional

manager_idinteger · idoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/api/1.0/processes/{processId}' \
  --header 'Content-Type: application/json' \
  --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
  }'

200

{
  "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-04-02T12:35:58.505Z",
  "created_at": "2025-04-02T12:35:58.505Z",
  "updated_at": "2025-04-02T12:35:58.505Z",
  "notifications": {},
  "task_notifications": {}
}

success

{
  "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-04-02T12:35:58.505Z",
      "created_at": "2025-04-02T12:35:58.505Z",
      "updated_at": "2025-04-02T12:35:58.505Z",
      "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
  }
}

Validate a import

post

Validate the specified process before importing.

Authorizations

Body

filestring · binaryoptional

file to import

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

{
  "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
}

success

Import a new process

post

Import the specified process.

Authorizations

Body

filestring · binaryoptional

file to import

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

{
  "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
}

success

Update assignments after import

post

Import Assignments of process.

Authorizations

Path parameters

process_idintegerrequired

ID of process to return

Body

assignableobject[]optional

cancel_requestobjectoptional

edit_dataobjectoptional

Responses

cURL

JavaScript

Python

HTTP

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

204

No body

success

Start a new process

post

Trigger an start event within a process.

Authorizations

Path parameters

process_idintegerrequired

ID of process to return

Query parameters

eventstringrequired

Node ID of the start event

Body

objectoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

{
  "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-04-02T12:35:58.505Z",
  "updated_at": "2025-04-02T12:35:58.505Z",
  "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-04-02T12:35:58.505Z",
          "updated_at": "2025-04-02T12:35:58.505Z"
        }
      ],
      "birthdate": "2025-04-02",
      "delegation_user_id": "text",
      "manager_id": "text",
      "meta": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "force_change_password": true,
      "id": 1,
      "created_at": "2025-04-02T12:35:58.505Z",
      "updated_at": "2025-04-02T12:35:58.505Z",
      "deleted_at": "2025-04-02T12:35:58.505Z"
    }
  ]
}

success

Create or update a new setting

post

Create a new Settings css-override

Authorizations

Body

variablesstringoptional

sansSerifFontstringoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/1.0/customize-ui' \
  --header 'Content-Type: application/json' \
  --data '{
    "variables": "text",
    "sansSerifFont": "text"
  }'

201

{
  "key": "text",
  "config": [
    {}
  ],
  "name": "text",
  "helper": "text",
  "group": "text",
  "format": "text",
  "hidden": true,
  "readonly": true,
  "variables": "text",
  "sansSerifFont": "text",
  "id": "text",
  "created_at": "2025-04-02T12:35:58.505Z",
  "updated_at": "2025-04-02T12:35:58.505Z"
}

success

Save a new notifications

post

Store a newly created resource in storage.

Authorizations

Body

typestringoptional

Represents a notification definition.

notifiable_typestringoptional

notifiable_idintegeroptional

datastringoptional

namestringoptional

messagestringoptional

processNamestringoptional

userNamestringoptional

request_idstringoptional

urlstringoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/1.0/notifications' \
  --header 'Content-Type: application/json' \
  --data '{
    "type": "text",
    "notifiable_type": "text",
    "notifiable_id": 1,
    "data": "text",
    "name": "text",
    "message": "text",
    "processName": "text",
    "userName": "text",
    "request_id": "text",
    "url": "text"
  }'

201

{
  "type": "text",
  "notifiable_type": "text",
  "notifiable_id": 1,
  "data": "text",
  "name": "text",
  "message": "text",
  "processName": "text",
  "userName": "text",
  "request_id": "text",
  "url": "text",
  "id": "text",
  "read_at": "2025-04-02T12:35:58.505Z",
  "created_at": "2025-04-02T12:35:58.505Z",
  "updated_at": "2025-04-02T12:35:58.505Z"
}

success

Update a notification

put

Update a user

Authorizations

Path parameters

notification_idstringrequired

ID of notification to return

Body

typestringoptional

Represents a notification definition.

notifiable_typestringoptional

notifiable_idintegeroptional

datastringoptional

namestringoptional

messagestringoptional

processNamestringoptional

userNamestringoptional

request_idstringoptional

urlstringoptional

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/api/1.0/notifications/{notification_id}' \
  --header 'Content-Type: application/json' \
  --data '{
    "type": "text",
    "notifiable_type": "text",
    "notifiable_id": 1,
    "data": "text",
    "name": "text",
    "message": "text",
    "processName": "text",
    "userName": "text",
    "request_id": "text",
    "url": "text"
  }'

204

No body

success

Mark notifications as read by the user

put

Update notification as read

Authorizations

Body

message_idsstring[]optional

list of message ids that will be marked as read

routesstring[]optional

all messages that has an url that is in this list will be marked as read

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/api/1.0/read_notifications' \
  --header 'Content-Type: application/json' \
  --data '{
    "message_ids": [
      "text"
    ],
    "routes": [
      "text"
    ]
  }'

201

No body

success

Mark notifications as unread by the user

put

Update notifications as unread

Authorizations

Body

message_idsstring[]optional

list of message ids that will be marked as read

routesstring[]optional

all messages that has an url that is in this list will be marked as read

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/api/1.0/unread_notifications' \
  --header 'Content-Type: application/json' \
  --data '{
    "message_ids": [
      "text"
    ],
    "routes": [
      "text"
    ]
  }'

201

No body

success

Create or update a new setting

post

Create a new Settings css-override

Authorizations

Body

variablesstringoptional

sansSerifFontstringoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/1.0/customize-ui' \
  --header 'Content-Type: application/json' \
  --data '{
    "variables": "text",
    "sansSerifFont": "text"
  }'

201

{
  "key": "text",
  "config": [
    {}
  ],
  "name": "text",
  "helper": "text",
  "group": "text",
  "format": "text",
  "hidden": true,
  "readonly": true,
  "variables": "text",
  "sansSerifFont": "text",
  "id": "text",
  "created_at": "2025-04-02T12:35:58.505Z",
  "updated_at": "2025-04-02T12:35:58.505Z"
}

success

Save a new Screen Category

post

Store a newly created Screen Category in storage

Authorizations

Body

namestringoptional

Represents a business screen category definition.

statusstring · enumoptional

Available options:

Responses

application/json

cURL

JavaScript

Python

HTTP

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

201

{
  "name": "text",
  "status": "ACTIVE",
  "id": "text",
  "created_at": "2025-04-02T12:35:58.505Z",
  "updated_at": "2025-04-02T12:35:58.505Z"
}

success

Update a screen Category

put

Updates the current element

Authorizations

Path parameters

screen_category_idstringrequired

ID of screen category to return

Body

namestringoptional

Represents a business screen category definition.

statusstring · enumoptional

Available options:

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/api/1.0/screen_categories/{screen_category_id}' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "status": "ACTIVE"
  }'

200

{
  "name": "text",
  "status": "ACTIVE",
  "id": "text",
  "created_at": "2025-04-02T12:35:58.505Z",
  "updated_at": "2025-04-02T12:35:58.505Z"
}

success

Save a new screens

post

Create a new Screen.

Authorizations

Body

titlestringoptional

Class Screen

typestringoptional

descriptionstringoptional

configobject[]optional

computedobject[]optional

watchersobject[]optional

custom_cssstringoptional

screen_category_idstringoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/1.0/screens' \
  --header 'Content-Type: application/json' \
  --data '{
    "title": "text",
    "type": "text",
    "description": "text",
    "config": [
      {}
    ],
    "computed": [
      {}
    ],
    "watchers": [
      {}
    ],
    "custom_css": "text",
    "screen_category_id": "text"
  }'

201

{
  "title": "text",
  "type": "text",
  "description": "text",
  "config": [
    {}
  ],
  "computed": [
    {}
  ],
  "watchers": [
    {}
  ],
  "custom_css": "text",
  "screen_category_id": "text",
  "id": "text",
  "created_at": "2025-04-02T12:35:58.505Z",
  "updated_at": "2025-04-02T12:35:58.505Z"
}

success

Update a screen

put

Update a Screen.

Authorizations

Path parameters

screens_idstringrequired

ID of screen to return

Body

titlestringoptional

Class Screen

typestringoptional

descriptionstringoptional

configobject[]optional

computedobject[]optional

watchersobject[]optional

custom_cssstringoptional

screen_category_idstringoptional

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/api/1.0/screens/{screens_id}' \
  --header 'Content-Type: application/json' \
  --data '{
    "title": "text",
    "type": "text",
    "description": "text",
    "config": [
      {}
    ],
    "computed": [
      {}
    ],
    "watchers": [
      {}
    ],
    "custom_css": "text",
    "screen_category_id": "text"
  }'

204

No body

success

duplicate a screen

put

duplicate a Screen.

Authorizations

Path parameters

screens_idstringrequired

ID of screen to return

Body

titlestringoptional

Class Screen

typestringoptional

descriptionstringoptional

configobject[]optional

computedobject[]optional

watchersobject[]optional

custom_cssstringoptional

screen_category_idstringoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/api/1.0/screens/{screens_id}/duplicate' \
  --header 'Content-Type: application/json' \
  --data '{
    "title": "text",
    "type": "text",
    "description": "text",
    "config": [
      {}
    ],
    "computed": [
      {}
    ],
    "watchers": [
      {}
    ],
    "custom_css": "text",
    "screen_category_id": "text"
  }'

201

{
  "title": "text",
  "type": "text",
  "description": "text",
  "config": [
    {}
  ],
  "computed": [
    {}
  ],
  "watchers": [
    {}
  ],
  "custom_css": "text",
  "screen_category_id": "text",
  "id": "text",
  "created_at": "2025-04-02T12:35:58.505Z",
  "updated_at": "2025-04-02T12:35:58.505Z"
}

success

Preview a screen

post

Get preview a screen

Authorizations

Body

configobjectoptional

watchersobjectoptional

computedobjectoptional

custom_cssstringoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/1.0/screens/preview' \
  --header 'Content-Type: application/json' \
  --data '{
    "config": {},
    "watchers": {},
    "computed": {},
    "custom_css": "text"
  }'

200

{
  "title": "text",
  "type": "text",
  "description": "text",
  "config": [
    {}
  ],
  "computed": [
    {}
  ],
  "watchers": [
    {}
  ],
  "custom_css": "text",
  "screen_category_id": "text",
  "id": "text",
  "created_at": "2025-04-02T12:35:58.505Z",
  "updated_at": "2025-04-02T12:35:58.505Z"
}

Successfully found the screen

Save a new Script Category

post

Store a newly created Script Category in storage

Authorizations

Body

namestringoptional

Represents a business script category definition.

statusstring · enumoptional

Available options:

Responses

application/json

cURL

JavaScript

Python

HTTP

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

201

{
  "name": "text",
  "status": "ACTIVE",
  "id": "text",
  "created_at": "2025-04-02T12:35:58.505Z",
  "updated_at": "2025-04-02T12:35:58.505Z"
}

success

Update a script Category

put

Updates the current element

Authorizations

Path parameters

script_category_idstringrequired

ID of script category to return

Body

namestringoptional

Represents a business script category definition.

statusstring · enumoptional

Available options:

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/api/1.0/script_categories/{script_category_id}' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "status": "ACTIVE"
  }'

200

{
  "name": "text",
  "status": "ACTIVE",
  "id": "text",
  "created_at": "2025-04-02T12:35:58.505Z",
  "updated_at": "2025-04-02T12:35:58.505Z"
}

success

Save a new script

post

Create a new script in a process.

Authorizations

Body

titlestringoptional

Represents an Eloquent model of a Script

descriptionstringoptional

languagestringoptional

codestringoptional

timeoutintegeroptional

run_as_user_idintegeroptional

keystringoptional

script_category_idintegeroptional

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/1.0/scripts' \
  --header 'Content-Type: application/json' \
  --data '{
    "title": "text",
    "description": "text",
    "language": "text",
    "code": "text",
    "timeout": 1,
    "run_as_user_id": 1,
    "key": "text",
    "script_category_id": 1
  }'

201

{
  "title": "text",
  "description": "text",
  "language": "text",
  "code": "text",
  "timeout": 1,
  "run_as_user_id": 1,
  "key": "text",
  "script_category_id": 1,
  "id": 1,
  "created_at": "2025-04-02T12:35:58.505Z",
  "updated_at": "2025-04-02T12:35:58.505Z"
}

success

Test script code without saving it

post

Previews executing a script, with sample data/config data

Authorizations

Path parameters

script_idintegerrequired

Body

dataobject[]optional

configobject[]optional

codestringoptional

noncestringoptional

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/1.0/scripts/{script_id}/preview' \
  --header 'Content-Type: application/json' \
  --data '{
    "data": [
      {}
    ],
    "config": [
      {}
    ],
    "code": "text",
    "nonce": "text"
  }'

200

No body

success if the script was queued

Execute script

post

Executes a script, with sample data/config data

Authorizations

Path parameters

script_idintegerrequired

Body

dataobject[]optional

configobject[]optional

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/1.0/scripts/execute/{script_id}' \
  --header 'Content-Type: application/json' \
  --data '{
    "data": [
      {}
    ],
    "config": [
      {}
    ]
  }'

200

{
  "status": "text",
  "key": "text"
}

success if the script was queued

Update a script

put

Update a script in a process.

Authorizations

Path parameters

script_idstringrequired

ID of script to return

Body

titlestringoptional

Represents an Eloquent model of a Script

descriptionstringoptional

languagestringoptional

codestringoptional

timeoutintegeroptional

run_as_user_idintegeroptional

keystringoptional

script_category_idintegeroptional

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/api/1.0/scripts/{script_id}' \
  --header 'Content-Type: application/json' \
  --data '{
    "title": "text",
    "description": "text",
    "language": "text",
    "code": "text",
    "timeout": 1,
    "run_as_user_id": 1,
    "key": "text",
    "script_category_id": 1
  }'

204

No body

success

duplicate a script

put

duplicate a Script.

Authorizations

Path parameters

scripts_idstringrequired

ID of script to return

Body

titlestringoptional

Represents an Eloquent model of a Script

descriptionstringoptional

languagestringoptional

codestringoptional

timeoutintegeroptional

run_as_user_idintegeroptional

keystringoptional

script_category_idintegeroptional

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/api/1.0/scripts/{scripts_id}/duplicate' \
  --header 'Content-Type: application/json' \
  --data '{
    "title": "text",
    "description": "text",
    "language": "text",
    "code": "text",
    "timeout": 1,
    "run_as_user_id": 1,
    "key": "text",
    "script_category_id": 1
  }'

201

{
  "title": "text",
  "description": "text",
  "language": "text",
  "code": "text",
  "timeout": 1,
  "run_as_user_id": 1,
  "key": "text",
  "script_category_id": 1,
  "id": 1,
  "created_at": "2025-04-02T12:35:58.505Z",
  "updated_at": "2025-04-02T12:35:58.505Z"
}

success

Create a script executor

post

Create a script executor

Authorizations

Body

titlestringoptional

Represents an Eloquent model of a Script Executor

descriptionstringoptional

languagestringoptional

configstringoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/1.0/script-executors' \
  --header 'Content-Type: application/json' \
  --data '{
    "title": "text",
    "description": "text",
    "language": "text",
    "config": "text"
  }'

200

{
  "status": "text",
  "id": "text"
}

success

Update script executor

put

Update and rebuild the script executor

Authorizations

Path parameters

script_executorstringrequired

ID of script executor to return

Body

titlestringoptional

Represents an Eloquent model of a Script Executor

descriptionstringoptional

languagestringoptional

configstringoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/api/1.0/script-executors/{script_executor}' \
  --header 'Content-Type: application/json' \
  --data '{
    "title": "text",
    "description": "text",
    "language": "text",
    "config": "text"
  }'

200

{
  "status": "text"
}

success

{
  "data": [
    {
      "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-04-02T12:35:58.505Z",
          "updated_at": "2025-04-02T12:35:58.505Z"
        }
      ],
      "birthdate": "2025-04-02",
      "delegation_user_id": "text",
      "manager_id": "text",
      "meta": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "force_change_password": true,
      "id": 1,
      "created_at": "2025-04-02T12:35:58.505Z",
      "updated_at": "2025-04-02T12:35:58.505Z",
      "deleted_at": "2025-04-02T12:35:58.505Z"
    }
  ],
  "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
  }
}

Save a new users

post

Store a newly created resource in storage.

Authorizations

Body

emailstring · emailoptional

The attributes that are mass assignable.

firstnamestringoptional

lastnamestringoptional

usernamestringoptional

passwordstringoptional

addressstringoptional

citystringoptional

statestringoptional

postalstringoptional

countrystringoptional

phonestringoptional

faxstringoptional

cellstringoptional

titlestringoptional

timezonestringoptional

datetime_formatstringoptional

languagestringoptional

is_administratorbooleanoptional

expires_atstringoptional

loggedin_atstringoptional

remember_tokenstringoptional

statusstring · enumoptional

Available options:

fullnamestringoptional

avatarstringoptional

mediaall of[]optional

birthdatestring · dateoptional

delegation_user_idstring · idoptional

manager_idstring · idoptional

metaobjectoptional

force_change_passwordbooleanoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/1.0/users' \
  --header 'Content-Type: application/json' \
  --data '{
    "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-04-02T12:35:58.505Z",
        "updated_at": "2025-04-02T12:35:58.505Z"
      }
    ],
    "birthdate": "2025-04-02",
    "delegation_user_id": "text",
    "manager_id": "text",
    "meta": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "force_change_password": true
  }'

201

422

{
  "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-04-02T12:35:58.505Z",
      "updated_at": "2025-04-02T12:35:58.505Z"
    }
  ],
  "birthdate": "2025-04-02",
  "delegation_user_id": "text",
  "manager_id": "text",
  "meta": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "force_change_password": true,
  "id": 1,
  "created_at": "2025-04-02T12:35:58.505Z",
  "updated_at": "2025-04-02T12:35:58.505Z",
  "deleted_at": "2025-04-02T12:35:58.505Z"
}

success

{
  "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-04-02T12:35:58.505Z",
      "updated_at": "2025-04-02T12:35:58.505Z"
    }
  ],
  "birthdate": "2025-04-02",
  "delegation_user_id": "text",
  "manager_id": "text",
  "meta": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "force_change_password": true,
  "id": 1,
  "created_at": "2025-04-02T12:35:58.505Z",
  "updated_at": "2025-04-02T12:35:58.505Z",
  "deleted_at": "2025-04-02T12:35:58.505Z"
}

Update a user

put

Update a user

Authorizations

Path parameters

user_idintegerrequired

ID of user to return

Body

emailstring · emailoptional

The attributes that are mass assignable.

firstnamestringoptional

lastnamestringoptional

usernamestringoptional

passwordstringoptional

addressstringoptional

citystringoptional

statestringoptional

postalstringoptional

countrystringoptional

phonestringoptional

faxstringoptional

cellstringoptional

titlestringoptional

timezonestringoptional

datetime_formatstringoptional

languagestringoptional

is_administratorbooleanoptional

expires_atstringoptional

loggedin_atstringoptional

remember_tokenstringoptional

statusstring · enumoptional

Available options:

fullnamestringoptional

avatarstringoptional

mediaall of[]optional

birthdatestring · dateoptional

delegation_user_idstring · idoptional

manager_idstring · idoptional

metaobjectoptional

force_change_passwordbooleanoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/api/1.0/users/{user_id}' \
  --header 'Content-Type: application/json' \
  --data '{
    "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-04-02T12:35:58.505Z",
        "updated_at": "2025-04-02T12:35:58.505Z"
      }
    ],
    "birthdate": "2025-04-02",
    "delegation_user_id": "text",
    "manager_id": "text",
    "meta": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "force_change_password": true
  }'

204

404

422

No body

success

Set the groups a users belongs to

put

Update a user's groups

Authorizations

Path parameters

user_idintegerrequired

ID of user

Body

groupsinteger[]optional

Example: 1

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/api/1.0/users/{user_id}/groups' \
  --header 'Content-Type: application/json' \
  --data '{
    "groups": [
      1
    ]
  }'

204

No body

success

Create new token for a specific user

post

Create a new personal access token for the user.

Authorizations

Path parameters

user_idintegerrequired

User id

Body

namestringoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/1.0/users/{user_id}/tokens' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text"
  }'

201

{
  "id": "text",
  "user_id": 1,
  "client_id": 1,
  "name": "text",
  "scopes": {},
  "revoked": true,
  "client": {
    "id": 1,
    "user_id": 1,
    "name": "text",
    "provider": "text",
    "redirect": "text",
    "personal_access_client": true,
    "password_client": true,
    "revoked": true,
    "created_at": "2025-04-02T12:35:58.505Z",
    "updated_at": "2025-04-02T12:35:58.505Z"
  },
  "created_at": "2025-04-02T12:35:58.505Z",
  "updated_at": "2025-04-02T12:35:58.505Z",
  "expires_at": "2025-04-02T12:35:58.505Z"
}

New token instance

Create or update a new setting

post

Create a new Settings css-override

Authorizations

Body

variablesstringoptional

sansSerifFontstringoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/1.0/customize-ui' \
  --header 'Content-Type: application/json' \
  --data '{
    "variables": "text",
    "sansSerifFont": "text"
  }'

201

{
  "key": "text",
  "config": [
    {}
  ],
  "name": "text",
  "helper": "text",
  "group": "text",
  "format": "text",
  "hidden": true,
  "readonly": true,
  "variables": "text",
  "sansSerifFont": "text",
  "id": "text",
  "created_at": "2025-04-02T12:35:58.505Z",
  "updated_at": "2025-04-02T12:35:58.505Z"
}

success

Save a new group

post

Store a newly created resource in storage.

Authorizations

Body

namestringoptional

Represents a group definition.

descriptionstringoptional

manager_idinteger · idoptional

statusstring · enumoptional

Available options:

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/1.0/groups' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "description": "text",
    "manager_id": 1,
    "status": "ACTIVE"
  }'

201

422

{
  "name": "text",
  "description": "text",
  "manager_id": 1,
  "status": "ACTIVE",
  "created_at": "2025-04-02T12:35:58.505Z",
  "updated_at": "2025-04-02T12:35:58.505Z",
  "id": "text"
}

success

Update a group

put

Update a user

Authorizations

Path parameters

group_idintegerrequired

ID of group to return

Body

namestringoptional

Represents a group definition.

descriptionstringoptional

manager_idinteger · idoptional

statusstring · enumoptional

Available options:

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/api/1.0/groups/{group_id}' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "description": "text",
    "manager_id": 1,
    "status": "ACTIVE"
  }'

204

404

No body

success

{
  "data": [
    {
      "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-04-02T12:35:58.505Z",
          "updated_at": "2025-04-02T12:35:58.505Z"
        }
      ],
      "birthdate": "2025-04-02",
      "delegation_user_id": "text",
      "manager_id": "text",
      "meta": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "force_change_password": true,
      "id": 1,
      "created_at": "2025-04-02T12:35:58.505Z",
      "updated_at": "2025-04-02T12:35:58.505Z",
      "deleted_at": "2025-04-02T12:35:58.505Z"
    }
  ],
  "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
  }
}

Save a new group member

post

Store a newly created resource in storage.

Authorizations

Body

group_idstring · idoptional

Represents a group Members definition.

member_idstring · idoptional

member_typestringoptional

descriptionstringoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/1.0/group_members' \
  --header 'Content-Type: application/json' \
  --data '{
    "group_id": "text",
    "member_id": "text",
    "member_type": "text",
    "description": "text"
  }'

201

{
  "group_id": "text",
  "member_id": "text",
  "member_type": "text",
  "description": "text",
  "id": "text",
  "group": {},
  "member": {},
  "created_at": "2025-04-02T12:35:58.505Z",
  "updated_at": "2025-04-02T12:35:58.505Z"
}

success

{
  "data": [
    {
      "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-04-02T12:35:58.505Z",
          "updated_at": "2025-04-02T12:35:58.505Z"
        }
      ],
      "birthdate": "2025-04-02",
      "delegation_user_id": "text",
      "manager_id": "text",
      "meta": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "force_change_password": true,
      "id": 1,
      "created_at": "2025-04-02T12:35:58.505Z",
      "updated_at": "2025-04-02T12:35:58.505Z",
      "deleted_at": "2025-04-02T12:35:58.505Z"
    }
  ],
  "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
  }
}

Create or update a new setting

post

Create a new Settings css-override

Authorizations

Body

variablesstringoptional

sansSerifFontstringoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/1.0/customize-ui' \
  --header 'Content-Type: application/json' \
  --data '{
    "variables": "text",
    "sansSerifFont": "text"
  }'

201

{
  "key": "text",
  "config": [
    {}
  ],
  "name": "text",
  "helper": "text",
  "group": "text",
  "format": "text",
  "hidden": true,
  "readonly": true,
  "variables": "text",
  "sansSerifFont": "text",
  "id": "text",
  "created_at": "2025-04-02T12:35:58.505Z",
  "updated_at": "2025-04-02T12:35:58.505Z"
}

success

{
  "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-04-02T12:35:58.505Z",
      "updated_at": "2025-04-02T12:35:58.505Z",
      "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-04-02T12:35:58.505Z",
              "updated_at": "2025-04-02T12:35:58.505Z"
            }
          ],
          "birthdate": "2025-04-02",
          "delegation_user_id": "text",
          "manager_id": "text",
          "meta": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "force_change_password": true,
          "id": 1,
          "created_at": "2025-04-02T12:35:58.505Z",
          "updated_at": "2025-04-02T12:35:58.505Z",
          "deleted_at": "2025-04-02T12:35:58.505Z"
        }
      ]
    }
  ],
  "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
  }
}

{
  "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-04-02T12:35:58.505Z",
  "updated_at": "2025-04-02T12:35:58.505Z",
  "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-04-02T12:35:58.505Z",
          "updated_at": "2025-04-02T12:35:58.505Z"
        }
      ],
      "birthdate": "2025-04-02",
      "delegation_user_id": "text",
      "manager_id": "text",
      "meta": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "force_change_password": true,
      "id": 1,
      "created_at": "2025-04-02T12:35:58.505Z",
      "updated_at": "2025-04-02T12:35:58.505Z",
      "deleted_at": "2025-04-02T12:35:58.505Z"
    }
  ]
}

Update a process request

put

Update a request

Authorizations

Path parameters

process_request_idintegerrequired

ID of process request to return

Body

user_idstring · idoptional

Represents an Eloquent model of a Request which is an instance of a Process.

callable_idstring · idoptional

dataobjectoptional

statusstring · enumoptional

Available options:

namestringoptional

process_idintegeroptional

processobjectoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/api/1.0/requests/{process_request_id}' \
  --header 'Content-Type: application/json' \
  --data '{
    "user_id": "text",
    "callable_id": "text",
    "data": {},
    "status": "ACTIVE",
    "name": "text",
    "process_id": 1,
    "process": {}
  }'

204

404

No body

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-04-02T12:35:58.505Z",
  "updated_at": "2025-04-02T12:35:58.505Z",
  "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-04-02T12:35:58.505Z",
          "updated_at": "2025-04-02T12:35:58.505Z"
        }
      ],
      "birthdate": "2025-04-02",
      "delegation_user_id": "text",
      "manager_id": "text",
      "meta": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "force_change_password": true,
      "id": 1,
      "created_at": "2025-04-02T12:35:58.505Z",
      "updated_at": "2025-04-02T12:35:58.505Z",
      "deleted_at": "2025-04-02T12:35:58.505Z"
    }
  ]
}

Save a new media file to a request

post

Store a newly created resource in storage.

Authorizations

Path parameters

request_idintegerrequired

ID of the request

Query parameters

data_namestringoptional

Variable name in the request data to use for the file name

Body

filestring · binaryoptional

save a new media file

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/1.0/requests/{request_id}/files' \
  --header 'Content-Type: multipart/form-data' \
  --form 'file=binary'

200

{
  "message": "text",
  "fileUploadId": 1
}

success

Create or update a new setting

post

Create a new Settings css-override

Authorizations

Body

variablesstringoptional

sansSerifFontstringoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/1.0/customize-ui' \
  --header 'Content-Type: application/json' \
  --data '{
    "variables": "text",
    "sansSerifFont": "text"
  }'

201

{
  "key": "text",
  "config": [
    {}
  ],
  "name": "text",
  "helper": "text",
  "group": "text",
  "format": "text",
  "hidden": true,
  "readonly": true,
  "variables": "text",
  "sansSerifFont": "text",
  "id": "text",
  "created_at": "2025-04-02T12:35:58.505Z",
  "updated_at": "2025-04-02T12:35:58.505Z"
}

success

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 · enumoptional

Available options:

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/1.0/task_assignments' \
  --header 'Content-Type: application/json' \
  --data '{
    "process_id": 1,
    "process_task_id": "text",
    "assignment_id": 1,
    "assignment_type": "ProcessMaker\\Models\\User"
  }'

201

422

{
  "process_id": 1,
  "process_task_id": "text",
  "assignment_id": 1,
  "assignment_type": "ProcessMaker\\Models\\User",
  "id": 1,
  "created_at": "2025-04-02T12:35:58.505Z",
  "updated_at": "2025-04-02T12:35:58.505Z"
}

success

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 · enumoptional

Available options:

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/api/1.0/task_assignments/{task_assignment}' \
  --header 'Content-Type: application/json' \
  --data '{
    "process_id": 1,
    "process_task_id": "text",
    "assignment_id": 1,
    "assignment_type": "ProcessMaker\\Models\\User"
  }'

204

404

422

No body

success

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 · enumoptional

Available options:

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/api/1.0/task_assignments/{task_assignment}' \
  --header 'Content-Type: application/json' \
  --data '{
    "process_id": 1,
    "process_task_id": "text",
    "assignment_id": 1,
    "assignment_type": "ProcessMaker\\Models\\User"
  }'

200

No body

success

{
  "data": [
    {
      "user_id": "text",
      "status": "text",
      "due_at": "2025-04-02T12:35:58.505Z",
      "initiated_at": "2025-04-02T12:35:58.505Z",
      "riskchanges_at": "2025-04-02T12:35:58.505Z",
      "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-04-02T12:35:58.505Z",
      "updated_at": "2025-04-02T12:35:58.505Z",
      "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
  }
}

Update a task

put

Updates the current element

Authorizations

Path parameters

task_idintegerrequired

ID of task to update

Body

statusstringrequired

Example: COMPLETED

dataobjectrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/api/1.0/tasks/{task_id}' \
  --header 'Content-Type: application/json' \
  --data '{
    "status": "COMPLETED",
    "data": {}
  }'

200

404

422

{
  "user_id": "text",
  "status": "text",
  "due_at": "2025-04-02T12:35:58.505Z",
  "initiated_at": "2025-04-02T12:35:58.505Z",
  "riskchanges_at": "2025-04-02T12:35:58.505Z",
  "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-04-02T12:35:58.505Z",
  "updated_at": "2025-04-02T12:35:58.505Z",
  "advanceStatus": "text",
  "due_notified": 1,
  "user": {},
  "process": {},
  "process_request": {}
}

success

Save a new Data Connector Category

post

Store a newly created Data Connector Category in storage

Authorizations

Body

namestringoptional

Represents a business data Source category definition.

statusstring · enumoptional

Available options:

Responses

application/json

cURL

JavaScript

Python

HTTP

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

201

{
  "name": "text",
  "status": "ACTIVE",
  "id": "text",
  "created_at": "2025-04-02T12:35:58.505Z",
  "updated_at": "2025-04-02T12:35:58.505Z"
}

success

Update a Data Connector Category

put

Updates the current element

Authorizations

Path parameters

data_source_category_idstringrequired

ID of Data Connector category to return

Body

namestringoptional

Represents a business data Source category definition.

statusstring · enumoptional

Available options:

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/api/1.0/data_source_categories/{data_source_category_id}' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "status": "ACTIVE"
  }'

200

{
  "name": "text",
  "status": "ACTIVE",
  "id": "text",
  "created_at": "2025-04-02T12:35:58.505Z",
  "updated_at": "2025-04-02T12:35:58.505Z"
}

success

Save a new Data Connector

post

Create a new Data Connector.

Authorizations

Body

idstring · idoptional

Class DataSource

namestringoptional

descriptionstringoptional

endpointsstringoptional

mappingsstringoptional

authtypestringoptional

credentialsstringoptional

statusstringoptional

data_source_category_idstringoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/1.0/data_sources' \
  --header 'Content-Type: application/json' \
  --data '{
    "id": "text",
    "name": "text",
    "description": "text",
    "endpoints": "text",
    "mappings": "text",
    "authtype": "text",
    "credentials": "text",
    "status": "text",
    "data_source_category_id": "text"
  }'

201

{
  "id": "text",
  "name": "text",
  "description": "text",
  "endpoints": "text",
  "mappings": "text",
  "authtype": "text",
  "credentials": "text",
  "status": "text",
  "data_source_category_id": "text",
  "created_at": "2025-04-02T12:35:58.505Z",
  "updated_at": "2025-04-02T12:35:58.505Z"
}

success

Update a Data Connector

put

Update a Data Connector.

Authorizations

Path parameters

data_source_idstringrequired

ID of Data Connector to return

Body

idstring · idoptional

Class DataSource

namestringoptional

descriptionstringoptional

endpointsstringoptional

mappingsstringoptional

authtypestringoptional

credentialsstringoptional

statusstringoptional

data_source_category_idstringoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/api/1.0/data_sources/data_source_id' \
  --header 'Content-Type: application/json' \
  --data '{
    "id": "text",
    "name": "text",
    "description": "text",
    "endpoints": "text",
    "mappings": "text",
    "authtype": "text",
    "credentials": "text",
    "status": "text",
    "data_source_category_id": "text"
  }'

204

{
  "id": "text",
  "name": "text",
  "description": "text",
  "endpoints": "text",
  "mappings": "text",
  "authtype": "text",
  "credentials": "text",
  "status": "text",
  "data_source_category_id": "text",
  "created_at": "2025-04-02T12:35:58.505Z",
  "updated_at": "2025-04-02T12:35:58.505Z"
}

success

Send a Data Connector request

post

Send a Data Connector request.

Authorizations

Path parameters

data_source_idstringrequired

ID of Data Connector to return

Body

idstring · idoptional

Class DataSource

namestringoptional

descriptionstringoptional

endpointsstringoptional

mappingsstringoptional

authtypestringoptional

credentialsstringoptional

statusstringoptional

data_source_category_idstringoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/1.0/data_sources/data_source_id/test' \
  --header 'Content-Type: application/json' \
  --data '{
    "id": "text",
    "name": "text",
    "description": "text",
    "endpoints": "text",
    "mappings": "text",
    "authtype": "text",
    "credentials": "text",
    "status": "text",
    "data_source_category_id": "text"
  }'

204

{
  "id": "text",
  "name": "text",
  "description": "text",
  "endpoints": "text",
  "mappings": "text",
  "authtype": "text",
  "credentials": "text",
  "status": "text",
  "data_source_category_id": "text",
  "created_at": "2025-04-02T12:35:58.505Z",
  "updated_at": "2025-04-02T12:35:58.505Z"
}

success

execute Data Source

post

Execute a data Source endpoint

Authorizations

Path parameters

request_idstringrequired

ID of the request in whose context the datasource will be executed

data_source_idstringrequired

ID of DataSource to be run

Body

configobjectoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/1.0/requests/{request_id}/data_sources/{data_source_id}' \
  --header 'Content-Type: application/json' \
  --data '{
    "config": {
      "endpoint": "text",
      "dataMapping": [
        {
          "key": "text",
          "value": "text"
        }
      ],
      "outboundConfig": [
        {
          "key": "text",
          "value": "text"
        }
      ]
    }
  }'

200

{
  "status": 1,
  "response": {}
}

success

execute Data Source

post

Authorizations

Path parameters

data_source_idstringrequired

ID of DataSource to be run

Body

configobjectoptional

dataobjectoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/1.0/requests/data_sources/{data_source_id}' \
  --header 'Content-Type: application/json' \
  --data '{
    "config": {
      "endpoint": "text",
      "dataMapping": [
        {
          "key": "text",
          "value": "text"
        }
      ],
      "outboundConfig": [
        {
          "key": "text",
          "value": "text"
        }
      ]
    },
    "data": {}
  }'

200

{
  "status": 1,
  "response": {}
}

success

Save a new saved search chart

post

Create a new SavedSearchChart.

Authorizations

Path parameters

saved_search_idstringrequired

ID of saved search to which this chart will be saved

Body

titlestringoptional

Represents an Eloquent model of a Saved Search Chart.

typestring · enumoptional

Available options:

configobjectoptional

sortintegeroptional

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/1.0/saved-searches/{saved_search_id}/charts' \
  --header 'Content-Type: application/json' \
  --data '{
    "title": "text",
    "type": "bar",
    "config": {
      "ANY_ADDITIONAL_PROPERTY": null
    },
    "sort": 1
  }'

201

{
  "id": "text",
  "saved_search_id": "text",
  "user_id": "text",
  "created_at": "2025-04-02T12:35:58.505Z",
  "updated_at": "2025-04-02T12:35:58.505Z",
  "deleted_at": "2025-04-02T12:35:58.505Z",
  "title": "text",
  "type": "bar",
  "config": {
    "ANY_ADDITIONAL_PROPERTY": null
  },
  "sort": 1
}

success

Update several saved search charts at once

put

Batch update several SavedSearchCharts.

Authorizations

Path parameters

saved_search_idstringrequired

ID of saved search to which these charts will be saved

Body

itemsall ofoptional

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/api/1.0/saved-searches/{saved_search_id}/charts' \
  --header 'Content-Type: application/json' \
  --data '[
    {
      "id": "text",
      "saved_search_id": "text",
      "user_id": "text",
      "created_at": "2025-04-02T12:35:58.505Z",
      "updated_at": "2025-04-02T12:35:58.505Z",
      "deleted_at": "2025-04-02T12:35:58.505Z",
      "title": "text",
      "type": "bar",
      "config": {
        "ANY_ADDITIONAL_PROPERTY": null
      },
      "sort": 1
    }
  ]'

204

No body

success

Update a saved search chart

put

Update a SavedSearchChart.

Authorizations

Path parameters

chart_idstringrequired

ID of chart to return

Body

titlestringoptional

Represents an Eloquent model of a Saved Search Chart.

typestring · enumoptional

Available options:

configobjectoptional

sortintegeroptional

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/api/1.0/saved-searches/charts/{chart_id}' \
  --header 'Content-Type: application/json' \
  --data '{
    "title": "text",
    "type": "bar",
    "config": {
      "ANY_ADDITIONAL_PROPERTY": null
    },
    "sort": 1
  }'

200

{
  "id": "text",
  "saved_search_id": "text",
  "user_id": "text",
  "created_at": "2025-04-02T12:35:58.505Z",
  "updated_at": "2025-04-02T12:35:58.505Z",
  "deleted_at": "2025-04-02T12:35:58.505Z",
  "title": "text",
  "type": "bar",
  "config": {
    "ANY_ADDITIONAL_PROPERTY": null
  },
  "sort": 1
}

success

Save a new report

post

Authorizations

Body

typestring · enumoptional

Available options:

formatstring · enumoptional

Available options:

saved_search_idintegeroptional

configobjectoptional

tostring[]optional

subjectstringoptional

bodystringoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/1.0/saved-searches/reports' \
  --header 'Content-Type: application/json' \
  --data '{
    "type": "adhoc",
    "format": "csv",
    "saved_search_id": 1,
    "config": {
      "ANY_ADDITIONAL_PROPERTY": null
    },
    "to": [
      "text"
    ],
    "subject": "text",
    "body": "text"
  }'

201

{
  "id": "text",
  "user_id": "text",
  "created_at": "2025-04-02T12:35:58.505Z",
  "updated_at": "2025-04-02T12:35:58.505Z",
  "meta": {
    "ANY_ADDITIONAL_PROPERTY": null
  },
  "pmql": "text",
  "title": "text",
  "type": "task"
}

success

Update a saved search

put

Update a Report

Authorizations

Path parameters

reportIdstringrequired

ID of report

Body

metaobjectoptional

Represents an Eloquent model of a Saved Search.

pmqlstringoptional

titlestringoptional

typestring · enumoptional

Available options:

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/api/1.0/saved-searches/reports/{reportId}' \
  --header 'Content-Type: application/json' \
  --data '{
    "meta": {
      "ANY_ADDITIONAL_PROPERTY": null
    },
    "pmql": "text",
    "title": "text",
    "type": "task"
  }'

200

{
  "id": "text",
  "user_id": "text",
  "created_at": "2025-04-02T12:35:58.505Z",
  "updated_at": "2025-04-02T12:35:58.505Z",
  "meta": {
    "ANY_ADDITIONAL_PROPERTY": null
  },
  "pmql": "text",
  "title": "text",
  "type": "task"
}

success

Save a new saved search

post

Create a new SavedSearch.

Authorizations

Body

metaobjectoptional

Represents an Eloquent model of a Saved Search.

pmqlstringoptional

titlestringoptional

typestring · enumoptional

Available options:

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/1.0/saved-searches' \
  --header 'Content-Type: application/json' \
  --data '{
    "meta": {
      "ANY_ADDITIONAL_PROPERTY": null
    },
    "pmql": "text",
    "title": "text",
    "type": "task"
  }'

201

{
  "id": "text",
  "user_id": "text",
  "created_at": "2025-04-02T12:35:58.505Z",
  "updated_at": "2025-04-02T12:35:58.505Z",
  "meta": {
    "ANY_ADDITIONAL_PROPERTY": null
  },
  "pmql": "text",
  "title": "text",
  "type": "task"
}

success

Update a saved search

put

Update a SavedSearch.

Authorizations

Path parameters

savedSearchIdstringrequired

ID of saved search to return

Body

metaobjectoptional

Represents an Eloquent model of a Saved Search.

pmqlstringoptional

titlestringoptional

typestring · enumoptional

Available options:

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/api/1.0/saved-searches/{savedSearchId}' \
  --header 'Content-Type: application/json' \
  --data '{
    "meta": {
      "ANY_ADDITIONAL_PROPERTY": null
    },
    "pmql": "text",
    "title": "text",
    "type": "task"
  }'

200

{
  "id": "text",
  "user_id": "text",
  "created_at": "2025-04-02T12:35:58.505Z",
  "updated_at": "2025-04-02T12:35:58.505Z",
  "meta": {
    "ANY_ADDITIONAL_PROPERTY": null
  },
  "pmql": "text",
  "title": "text",
  "type": "task"
}

success

{
  "data": [
    {
      "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-04-02T12:35:58.505Z",
          "updated_at": "2025-04-02T12:35:58.505Z"
        }
      ],
      "birthdate": "2025-04-02",
      "delegation_user_id": "text",
      "manager_id": "text",
      "meta": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "force_change_password": true,
      "id": 1,
      "created_at": "2025-04-02T12:35:58.505Z",
      "updated_at": "2025-04-02T12:35:58.505Z",
      "deleted_at": "2025-04-02T12:35:58.505Z"
    }
  ],
  "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
  }
}

Save a new collections

post

Create a new Collection.

Authorizations

Body

namestringoptional

descriptionstringoptional

custom_titlestringoptional

create_screen_idstring · idoptional

read_screen_idstring · idoptional

update_screen_idstring · idoptional

signal_createbooleanoptional

signal_updatebooleanoptional

signal_deletebooleanoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/1.0/collections' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "description": "text",
    "custom_title": "text",
    "create_screen_id": "text",
    "read_screen_id": "text",
    "update_screen_id": "text",
    "signal_create": true,
    "signal_update": true,
    "signal_delete": true
  }'

201

{
  "name": "text",
  "description": "text",
  "custom_title": "text",
  "create_screen_id": "text",
  "read_screen_id": "text",
  "update_screen_id": "text",
  "signal_create": true,
  "signal_update": true,
  "signal_delete": true,
  "id": 1,
  "created_at": "2025-04-02T12:35:58.505Z",
  "updated_at": "2025-04-02T12:35:58.505Z",
  "created_by_id": "text",
  "updated_by_id": "text",
  "columns": [
    {}
  ]
}

success

Update a collection

put

Update a Collection.

Authorizations

Path parameters

collection_idstringrequired

ID of collection to update

Body

namestringoptional

descriptionstringoptional

custom_titlestringoptional

create_screen_idstring · idoptional

read_screen_idstring · idoptional

update_screen_idstring · idoptional

signal_createbooleanoptional

signal_updatebooleanoptional

signal_deletebooleanoptional

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/api/1.0/collections/{collection_id}' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "description": "text",
    "custom_title": "text",
    "create_screen_id": "text",
    "read_screen_id": "text",
    "update_screen_id": "text",
    "signal_create": true,
    "signal_update": true,
    "signal_delete": true
  }'

204

No body

success

Save a new record in a collection

post

Create a new record in a Collection.

Authorizations

Path parameters

collection_idstringrequired

ID of the collection

Body

dataobjectoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/1.0/collections/{collection_id}/records' \
  --header 'Content-Type: application/json' \
  --data '{
    "data": {}
  }'

201

{
  "data": {},
  "id": 1,
  "collection_id": "text"
}

success

Update a record

put

Update a record in a Collection.

Authorizations

Path parameters

collection_idstringrequired

ID of collection

record_idstringrequired

ID of the record

Body

dataobjectoptional

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/api/1.0/collections/{collection_id}/records/{record_id}' \
  --header 'Content-Type: application/json' \
  --data '{
    "data": {}
  }'

204

No body

success

Partial update of a record

patch

Implements a partial update of a record in a Collection.

Authorizations

Path parameters

collection_idstringrequired

ID of collection

record_idstringrequired

ID of the record

Body

namestringoptional

descriptionstringoptional

custom_titlestringoptional

create_screen_idstring · idoptional

read_screen_idstring · idoptional

update_screen_idstring · idoptional

signal_createbooleanoptional

signal_updatebooleanoptional

signal_deletebooleanoptional

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request PATCH \
  --url '/api/1.0/collections/{collection_id}/records/{record_id}' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "description": "text",
    "custom_title": "text",
    "create_screen_id": "text",
    "read_screen_id": "text",
    "update_screen_id": "text",
    "signal_create": true,
    "signal_update": true,
    "signal_delete": true
  }'

200

No body

success

Returns all Decision Tables categories that the user has access to

get

Display a listing of the Decision Tables Categories.

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 · enum · default: "asc"optional

Available options:

per_pageinteger · default: "10"optional

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

{
  "data": [
    {
      "name": "text",
      "status": "ACTIVE",
      "id": "text",
      "created_at": "2025-04-02T12:35:58.505Z",
      "updated_at": "2025-04-02T12:35:58.505Z"
    }
  ],
  "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
  }
}

list of Decision Tables categories

Get single Decision Table category by ID

get

Display the specified decision Tables category.

Authorizations

Path parameters

decision_table_categories_idstringrequired

ID of Decision Table category to return

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/1.0/decision_table_categories/{decision_table_categories_id}'

200

{
  "name": "text",
  "status": "ACTIVE",
  "id": "text",
  "created_at": "2025-04-02T12:35:58.505Z",
  "updated_at": "2025-04-02T12:35:58.505Z"
}

Successfully found the Decision Table

Returns all Decision tables that the user has access to

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 · enum · default: "asc"optional

Available options:

per_pageinteger · default: "10"optional

includestring · default: ""optional

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

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

{
  "data": [
    {
      "id": "text",
      "name": "text",
      "description": "text",
      "definition": "text",
      "decision_table_categories_id": "text",
      "created_at": "2025-04-02T12:35:58.505Z",
      "updated_at": "2025-04-02T12:35:58.505Z"
    }
  ],
  "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
  }
}

list of Decision Tables

Get single Decision Table by ID

get

Display the specified resource.

Authorizations

Path parameters

decision_table_idstringrequired

ID of Decision Table to return

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/1.0/decision_tables/{decision_table_id}'

200

{
  "id": "text",
  "name": "text",
  "description": "text",
  "definition": "text",
  "decision_table_categories_id": "text",
  "created_at": "2025-04-02T12:35:58.505Z",
  "updated_at": "2025-04-02T12:35:58.505Z"
}

Successfully found the Decision Table

Delete a Decision Table

delete

Delete a Decision tables

Authorizations

Path parameters

decision_table_idstringrequired

ID of Decision Table to return

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/api/1.0/decision_tables/{decision_table_id}'

204

{
  "id": "text",
  "name": "text",
  "description": "text",
  "definition": "text",
  "decision_table_categories_id": "text",
  "created_at": "2025-04-02T12:35:58.505Z",
  "updated_at": "2025-04-02T12:35:58.505Z"
}

success

Save a new Decision Table Category

post

Store a newly created Decision Tables Category in storage

Authorizations

Body

namestringoptional

Represents a business decision Table category definition.

statusstring · enumoptional

Available options:

Responses

application/json

cURL

JavaScript

Python

HTTP

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

201

{
  "name": "text",
  "status": "ACTIVE",
  "id": "text",
  "created_at": "2025-04-02T12:35:58.505Z",
  "updated_at": "2025-04-02T12:35:58.505Z"
}

success

Update a Decision Table Category

put

Updates the current element

Authorizations

Path parameters

decision_table_categories_idstringrequired

ID of Decision Table category to return

Body

namestringoptional

Represents a business decision Table category definition.

statusstring · enumoptional

Available options:

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/api/1.0/decision_table_categories/{decision_table_categories_id}' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "status": "ACTIVE"
  }'

200

{
  "name": "text",
  "status": "ACTIVE",
  "id": "text",
  "created_at": "2025-04-02T12:35:58.505Z",
  "updated_at": "2025-04-02T12:35:58.505Z"
}

success

Save a new Decision Table

post

Store a newly created resource in storage.

Authorizations

Body

idstring · idoptional

Class Screen

namestringoptional

descriptionstringoptional

definitionstringoptional

decision_table_categories_idstringoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/1.0/decision_tables' \
  --header 'Content-Type: application/json' \
  --data '{
    "id": "text",
    "name": "text",
    "description": "text",
    "definition": "text",
    "decision_table_categories_id": "text"
  }'

201

{
  "id": "text",
  "name": "text",
  "description": "text",
  "definition": "text",
  "decision_table_categories_id": "text",
  "created_at": "2025-04-02T12:35:58.505Z",
  "updated_at": "2025-04-02T12:35:58.505Z"
}

success

Update a Decision Table

put

Update a Decision table

Authorizations

Path parameters

decision_table_idstringrequired

ID of Decision Table to return

Body

idstring · idoptional

Class Screen

namestringoptional

descriptionstringoptional

definitionstringoptional

decision_table_categories_idstringoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/api/1.0/decision_tables/{decision_table_id}' \
  --header 'Content-Type: application/json' \
  --data '{
    "id": "text",
    "name": "text",
    "description": "text",
    "definition": "text",
    "decision_table_categories_id": "text"
  }'

204

{
  "id": "text",
  "name": "text",
  "description": "text",
  "definition": "text",
  "decision_table_categories_id": "text",
  "created_at": "2025-04-02T12:35:58.505Z",
  "updated_at": "2025-04-02T12:35:58.505Z"
}

success

duplicate a Decision Table

put

duplicate a Decision table.

Authorizations

Path parameters

decision_table_idstringrequired

ID of Decision Table to return

Body

idstring · idoptional

Class Screen

namestringoptional

descriptionstringoptional

definitionstringoptional

decision_table_categories_idstringoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/api/1.0/decision_tables/{decision_table_id}/duplicate' \
  --header 'Content-Type: application/json' \
  --data '{
    "id": "text",
    "name": "text",
    "description": "text",
    "definition": "text",
    "decision_table_categories_id": "text"
  }'

201

{
  "id": "text",
  "name": "text",
  "description": "text",
  "definition": "text",
  "decision_table_categories_id": "text",
  "created_at": "2025-04-02T12:35:58.505Z",
  "updated_at": "2025-04-02T12:35:58.505Z"
}

success

Import a new decision table

post

Import a Decision table from excel

Authorizations

Path parameters

decision_table_idstringrequired

ID of Decision Table to return

Body

filestring · binaryoptional

file to import

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/1.0/decision_tables/{decision_table_id}/excel-import' \
  --header 'Content-Type: multipart/form-data' \
  --form 'file=binary'

201

{
  "status": {}
}

success

Return all version History according to the model

get

Get the list of records of Version History

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 · enum · default: "asc"optional

Available options:

per_pageinteger · default: "10"optional

includestring · default: ""optional

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

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

{
  "data": [
    {
      "versionable_id": 1,
      "versionable_type": "text",
      "name": "text",
      "subject": "text",
      "description": "text",
      "status": "ACTIVE",
      "created_at": "2025-04-02T12:35:58.505Z",
      "updated_at": "2025-04-02T12:35:58.505Z"
    }
  ],
  "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
  }
}

list of Version History

Get single Version History by ID

get

Get a single Version History.

Authorizations

Path parameters

version_history_idstringrequired

ID of Version History to return

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/1.0/version_histories/{version_history_id}'

200

{
  "versionable_id": 1,
  "versionable_type": "text",
  "name": "text",
  "subject": "text",
  "description": "text",
  "status": "ACTIVE",
  "created_at": "2025-04-02T12:35:58.505Z",
  "updated_at": "2025-04-02T12:35:58.505Z"
}

Successfully found the Version History

Delete a Version History

delete

Delete a Version History.

Authorizations

Path parameters

version_history_idstringrequired

ID of Version History to return

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/api/1.0/version_histories/{version_history_id}'

204

{
  "versionable_id": 1,
  "versionable_type": "text",
  "name": "text",
  "subject": "text",
  "description": "text",
  "status": "ACTIVE",
  "created_at": "2025-04-02T12:35:58.505Z",
  "updated_at": "2025-04-02T12:35:58.505Z"
}

success

Create or update a new setting

post

Create a new Settings css-override

Authorizations

Body

variablesstringoptional

sansSerifFontstringoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/1.0/customize-ui' \
  --header 'Content-Type: application/json' \
  --data '{
    "variables": "text",
    "sansSerifFont": "text"
  }'

201

{
  "key": "text",
  "config": [
    {}
  ],
  "name": "text",
  "helper": "text",
  "group": "text",
  "format": "text",
  "hidden": true,
  "readonly": true,
  "variables": "text",
  "sansSerifFont": "text",
  "id": "text",
  "created_at": "2025-04-02T12:35:58.505Z",
  "updated_at": "2025-04-02T12:35:58.505Z"
}

success

Save a new Version History

post

Create a new Version History.

Authorizations

Body

versionable_idintegeroptional

Class VersionHistoryCollection

versionable_typestringoptional

namestringoptional

subjectstringoptional

descriptionstringoptional

statusstring · enumoptional

Available options:

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/1.0/version_histories' \
  --header 'Content-Type: application/json' \
  --data '{
    "versionable_id": 1,
    "versionable_type": "text",
    "name": "text",
    "subject": "text",
    "description": "text",
    "status": "ACTIVE"
  }'

201

{
  "versionable_id": 1,
  "versionable_type": "text",
  "name": "text",
  "subject": "text",
  "description": "text",
  "status": "ACTIVE",
  "created_at": "2025-04-02T12:35:58.505Z",
  "updated_at": "2025-04-02T12:35:58.505Z"
}

success

Update a Version History

put

Update a Version History.

Authorizations

Path parameters

version_history_idstringrequired

ID of Version History to return

Body

versionable_idintegeroptional

Class VersionHistoryCollection

versionable_typestringoptional

namestringoptional

subjectstringoptional

descriptionstringoptional

statusstring · enumoptional

Available options:

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/api/1.0/version_histories/{version_history_id}' \
  --header 'Content-Type: application/json' \
  --data '{
    "versionable_id": 1,
    "versionable_type": "text",
    "name": "text",
    "subject": "text",
    "description": "text",
    "status": "ACTIVE"
  }'

204

{
  "versionable_id": 1,
  "versionable_type": "text",
  "name": "text",
  "subject": "text",
  "description": "text",
  "status": "ACTIVE",
  "created_at": "2025-04-02T12:35:58.505Z",
  "updated_at": "2025-04-02T12:35:58.505Z"
}

success

Clone a new Version History

post

Clone a new Version History.

Authorizations

Body

versionable_idintegeroptional

Class VersionHistoryCollection

versionable_typestringoptional

namestringoptional

subjectstringoptional

descriptionstringoptional

statusstring · enumoptional

Available options:

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/1.0/version_histories/clone' \
  --header 'Content-Type: application/json' \
  --data '{
    "versionable_id": 1,
    "versionable_type": "text",
    "name": "text",
    "subject": "text",
    "description": "text",
    "status": "ACTIVE"
  }'

201

{
  "versionable_id": 1,
  "versionable_type": "text",
  "name": "text",
  "subject": "text",
  "description": "text",
  "status": "ACTIVE",
  "created_at": "2025-04-02T12:35:58.505Z",
  "updated_at": "2025-04-02T12:35:58.505Z"
}

success

API

ProcessMaker Platform API Documentation

ProcessMaker Platform RESTful API

Overview

Test API Endpoints from the API Documentation

Make API Calls with the Data Connector

Platform API Reference

Users

Groups

Requests

Tasks

Processes

Screens

Environment Variables

Files

Notifications

Scripts

Administrative APIs

Premium API Reference

Data Connectors

Collections

Decision Engine

Saved Search

Tools

Users

ProcessMaker Platform RESTful API

Overview

Test API Endpoints from the API Documentation

Make API Calls with the Data Connector

Groups

Requests

Tasks

Environment Variables

Files

Processes

Notifications

Screens

Scripts

Data Connectors

Saved Search

Collections

Decision Engine

Returns all environmentVariables that the user has access to. For security, values are not included.

Get an environment variable by id. For security, the value is not included.

Delete an environment variable

Returns the list of files

Get the metadata of a file. To actually fetch the file see Get File Contents

Delete a media file

Get the contents of a file

Returns all processes categories that the user has access to

Get single process category by ID

Delete a process category

Returns all processes that the user has access to

Get single process by ID

Delete a process

Returns the list of processes that the user can start

Restore an inactive process

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

Check if the import is ready

Returns all notifications that the user has access to

Get single notification by ID

Delete a notification

Returns all screens categories that the user has access to

Get single screen category by ID

Delete a screen category

Returns all screens that the user has access to

Get single screens by ID

Delete a screen

Export a single screen by ID

Returns all scripts categories that the user has access to

Get single script category by ID

Delete a script category

Returns all scripts that the user has access to

Get the response of a script execution by execution key

Get single script by ID

Delete a script

Returns all script executors that the user has access to

Delete a script executor

Returns all available languages

Returns all users