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 ) 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 .

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

Versions

Tools

Postman Collection

Postman is one of the most popular tools used for interacting with APIs today.

The below contains an export of all available rest endpoints as a Postman collection.

Users

API Reference for ProcessMaker Users API

Delete a user

DELETE/api/1.0/users/{user_id}

Path parameters

user_id*integer

ID of user to delete

Response

success

Request

const response = await fetch('/api/1.0/users/{user_id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

{
  "error": "text"
}

Set the groups a users belongs to

Update a user's groups

PUT/api/1.0/users/{user_id}/groups

Path parameters

user_id*integer

ID of user

Body

groupsarray of integer

itemsinteger

Example: 1

Response

success

Request

const response = await fetch('/api/1.0/users/{user_id}/groups', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Restore a soft deleted user

Reverses the soft delete of a user

PUT/api/1.0/users/restore

Body

usernamestring

Username to restore

Response

success

Request

const response = await fetch('/api/1.0/users/restore', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Delete a token

Delete the given token for a user

DELETE/api/1.0/users/{user_id}/tokens/{token_id}

Path parameters

user_id*integer

User ID

token_id*string

Token ID

Response

success

Request

const response = await fetch('/api/1.0/users/{user_id}/tokens/{token_id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Groups

API Reference for ProcessMaker Group API

Create or update a new setting

Create a new Settings css-override

POST/api/1.0/customize-ui

Body

variablesstring

sansSerifFontstring

Response

success

Body

keystring

Class Settings

configarray of object

namestring

helperstring

groupstring

formatstring

hiddenboolean

readonlyboolean

variablesstring

sansSerifFontstring

idstring (id)

created_atstring (date-time)

updated_atstring (date-time)

Request

const response = await fetch('/api/1.0/customize-ui', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "key": "text",
  "config": [],
  "name": "text",
  "helper": "text",
  "group": "text",
  "format": "text",
  "hidden": false,
  "readonly": false,
  "variables": "text",
  "sansSerifFont": "text",
  "id": "text",
  "created_at": "2025-01-02T16:36:41.753Z",
  "updated_at": "2025-01-02T16:36:41.753Z"
}

Delete a group

Delete a user

DELETE/api/1.0/groups/{group_id}

Path parameters

group_id*integer

ID of group to return

Response

success

Request

const response = await fetch('/api/1.0/groups/{group_id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

{
  "error": "text"
}

Delete a group member

Delete a group membership

DELETE/api/1.0/group_members/{group_member_id}

Path parameters

group_member_id*string

ID of group_members to return

Response

success

Request

const response = await fetch('/api/1.0/group_members/{group_member_id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Requests

API Reference for ProcessMaker Request API

Create or update a new setting

Create a new Settings css-override

POST/api/1.0/customize-ui

Body

variablesstring

sansSerifFontstring

Response

success

Body

keystring

Class Settings

configarray of object

namestring

helperstring

groupstring

formatstring

hiddenboolean

readonlyboolean

variablesstring

sansSerifFontstring

idstring (id)

created_atstring (date-time)

updated_atstring (date-time)

Request

const response = await fetch('/api/1.0/customize-ui', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "key": "text",
  "config": [],
  "name": "text",
  "helper": "text",
  "group": "text",
  "format": "text",
  "hidden": false,
  "readonly": false,
  "variables": "text",
  "sansSerifFont": "text",
  "id": "text",
  "created_at": "2025-01-02T16:36:41.753Z",
  "updated_at": "2025-01-02T16:36:41.753Z"
}

Update a process request event

Trigger a intermediate catch event

POST/api/1.0/requests/{process_request_id}/events/{event_id}

Path parameters

process_request_id*string

ID of process request to return

event_id*string

ID of process event to return

Response

success

Request

const response = await fetch('/api/1.0/requests/{process_request_id}/events/{event_id}', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Save a new media file to a request

Store a newly created resource in storage.

POST/api/1.0/requests/{request_id}/files

Path parameters

request_id*integer

ID of the request

Query parameters

data_namestring

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

Body

filestring (binary)

save a new media file

Response

success

Body

messagestring

fileUploadIdinteger

Request

const response = await fetch('/api/1.0/requests/{request_id}/files', {
    method: 'POST',
    headers: {
      "Content-Type": "multipart/form-data"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

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

Get a file uploaded to a request

Display the specified resource.

GET/api/1.0/requests/{request_id}/files/{file_id}

Path parameters

request_id*integer

ID of the request

file_id*integer

ID of the file to return

Response

File stream

Body

string (binary)

Request

const response = await fetch('/api/1.0/requests/{request_id}/files/{file_id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

binary

Delete all media associated with a request

Remove the specified resource from storage.

DELETE/api/1.0/requests/{request_id}/files/{file_id}

Path parameters

file_id*integer

ID of the file

request_id*string

ID of the request

Response

success

Request

const response = await fetch('/api/1.0/requests/{request_id}/files/{file_id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

{
  "error": "text"
}

Processes

API Reference for ProcessMaker Process API

Get single process category by ID

Display the specified Process category.

GET/api/1.0/process_categories/{process_category_id}

Path parameters

process_category_id*integer

ID of process category to return

Response

Successfully found the process

Body

namestring

Represents a business process category definition.

statusenum

ACTIVEINACTIVE

idstring (id)

created_atstring (date-time)

updated_atstring (date-time)

Request

const response = await fetch('/api/1.0/process_categories/{process_category_id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "name": "text",
  "status": "ACTIVE",
  "id": "text",
  "created_at": "2025-01-02T16:36:41.753Z",
  "updated_at": "2025-01-02T16:36:41.753Z"
}

Delete a process

Remove the specified resource from storage.

DELETE/api/1.0/processes/{processId}

Path parameters

processId*integer

ID of process to return

Response

success

Request

const response = await fetch('/api/1.0/processes/{processId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

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

Export the specified process.

POST/api/1.0/processes/{processId}/export

Path parameters

processId*integer

ID of process to export

Response

Successfully built the process for export

Body

urlstring

Request

const response = await fetch('/api/1.0/processes/{processId}/export', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

{
  "url": "text"
}

Check if the import is ready

HEAD/api/1.0/processes/import/{code}/is_ready

Path parameters

code*string

Import code

Response

check is import is ready

Body

readyboolean

Request

const response = await fetch('/api/1.0/processes/import/{code}/is_ready', {
    method: 'HEAD',
    headers: {},
});
const data = await response.json();

Response

{
  "ready": false
}

Update assignments after import

Import Assignments of process.

POST/api/1.0/processes/{process_id}/import/assignments

Path parameters

process_id*integer

ID of process to return

Body

assignablearray of object

cancel_requestobject

edit_dataobject

Response

success

Request

const response = await fetch('/api/1.0/processes/{process_id}/import/assignments', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

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 .

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

Return an environment variable instance Using implicit model binding, will automatically return 404 if variable now found

GET/api/1.0/environment_variables/{environment_variable_id}

Path parameters

environment_variable_id*integer

ID of environment_variables to return

Response

success

Body

namestring

descriptionstring

valuestring

idinteger (id)

created_atstring (date-time)

updated_atstring (date-time)

Request

const response = await fetch('/api/1.0/environment_variables/{environment_variable_id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "name": "text",
  "description": "text",
  "value": "text",
  "id": 0,
  "created_at": "2025-01-02T16:36:41.753Z",
  "updated_at": "2025-01-02T16:36:41.753Z"
}

Create or update a new setting

Create a new Settings css-override

POST/api/1.0/customize-ui

Body

variablesstring

sansSerifFontstring

Response

success

Body

keystring

Class Settings

configarray of object

namestring

helperstring

groupstring

formatstring

hiddenboolean

readonlyboolean

variablesstring

sansSerifFontstring

idstring (id)

created_atstring (date-time)

updated_atstring (date-time)

Request

const response = await fetch('/api/1.0/customize-ui', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "key": "text",
  "config": [],
  "name": "text",
  "helper": "text",
  "group": "text",
  "format": "text",
  "hidden": false,
  "readonly": false,
  "variables": "text",
  "sansSerifFont": "text",
  "id": "text",
  "created_at": "2025-01-02T16:36:41.753Z",
  "updated_at": "2025-01-02T16:36:41.753Z"
}

Create or update a new setting

Create a new Settings css-override

POST/api/1.0/customize-ui

Body

variablesstring

sansSerifFontstring

Response

success

Body

keystring

Class Settings

configarray of object

namestring

helperstring

groupstring

formatstring

hiddenboolean

readonlyboolean

variablesstring

sansSerifFontstring

idstring (id)

created_atstring (date-time)

updated_atstring (date-time)

Request

const response = await fetch('/api/1.0/customize-ui', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "key": "text",
  "config": [],
  "name": "text",
  "helper": "text",
  "group": "text",
  "format": "text",
  "hidden": false,
  "readonly": false,
  "variables": "text",
  "sansSerifFont": "text",
  "id": "text",
  "created_at": "2025-01-02T16:36:41.753Z",
  "updated_at": "2025-01-02T16:36:41.753Z"
}

Create or update a new setting

Create a new Settings css-override

POST/api/1.0/customize-ui

Body

variablesstring

sansSerifFontstring

Response

success

Body

keystring

Class Settings

configarray of object

namestring

helperstring

groupstring

formatstring

hiddenboolean

readonlyboolean

variablesstring

sansSerifFontstring

idstring (id)

created_atstring (date-time)

updated_atstring (date-time)

Request

const response = await fetch('/api/1.0/customize-ui', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "key": "text",
  "config": [],
  "name": "text",
  "helper": "text",
  "group": "text",
  "format": "text",
  "hidden": false,
  "readonly": false,
  "variables": "text",
  "sansSerifFont": "text",
  "id": "text",
  "created_at": "2025-01-02T16:36:41.753Z",
  "updated_at": "2025-01-02T16:36:41.753Z"
}

Collections

Returns all collections that the user has access to

Get a list of Collections.

GET/api/1.0/collections

Query parameters

filterstring

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

order_bystring

Field to order results by

order_directionenum

ascdesc

per_pageinteger

includestring

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

Response

list of collections

Body

dataarray of collections (all of)

namestring

descriptionstring

custom_titlestring

create_screen_idstring (id)

read_screen_idstring (id)

update_screen_idstring (id)

signal_createboolean

signal_updateboolean

signal_deleteboolean

idinteger

created_atstring (date-time)

updated_atstring (date-time)

created_by_idstring (id)

updated_by_idstring (id)

columnsarray of object

metametadata (object)

filterstring

sort_bystring

sort_orderenum

ascdesc

countinteger

total_pagesinteger

current_pageinteger

forminteger

last_pageinteger

pathstring

per_pageinteger

tointeger

totalinteger

Request

Response

Save a new collections

Create a new Collection.

POST/api/1.0/collections

Body

namestring

descriptionstring

custom_titlestring

create_screen_idstring (id)

read_screen_idstring (id)

update_screen_idstring (id)

signal_createboolean

signal_updateboolean

signal_deleteboolean

Response

success

Body

namestring

descriptionstring

custom_titlestring

create_screen_idstring (id)

read_screen_idstring (id)

update_screen_idstring (id)

signal_createboolean

signal_updateboolean

signal_deleteboolean

idinteger

created_atstring (date-time)

updated_atstring (date-time)

created_by_idstring (id)

updated_by_idstring (id)

columnsarray of object

Request

Response

Get single collections by ID

Get a single Collection.

GET/api/1.0/collections/{collection_id}

Path parameters

collection_id*string

ID of collection to return

Response

Successfully found the collections

Body

namestring

descriptionstring

custom_titlestring

create_screen_idstring (id)

read_screen_idstring (id)

update_screen_idstring (id)

signal_createboolean

signal_updateboolean

signal_deleteboolean

idinteger

created_atstring (date-time)

updated_atstring (date-time)

created_by_idstring (id)

updated_by_idstring (id)

columnsarray of object

Request

Response

Update a collection

Update a Collection.

PUT/api/1.0/collections/{collection_id}

Path parameters

collection_id*string

ID of collection to update

Body

namestring

descriptionstring

custom_titlestring

create_screen_idstring (id)

read_screen_idstring (id)

update_screen_idstring (id)

signal_createboolean

signal_updateboolean

signal_deleteboolean

Response

success

Request

Delete a collection

Delete a Collection.

DELETE/api/1.0/collections/{collection_id}

Path parameters

collection_id*string

ID of collection to return

Response

success

Request

Trigger export collections job

Export the specified collection.

POST/api/1.0/collections/{collection_id}/export

Path parameters

collection_id*string

ID of the collection to export

Response

success

Request

Import a new collection

Import the specified collection.

POST/api/1.0/collections/import

Body

file*file (file)

file to upload

Response

success

Request

Response

Deletes all records in a collection

Truncate a Collection.

DELETE/api/1.0/collections/{collection_id}/truncate

Path parameters

collection_id*string

ID of collection to truncate

Response

success

Request

Returns all records

Get the list of records of a collection.

GET/api/1.0/collections/{collection_id}/records

Path parameters

collection_id*string

ID of collection to get records for

Query parameters

pmqlstring

per_pageinteger

filterstring

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

order_bystring

Field to order results by

order_directionenum

ascdesc

includestring

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

Response

list of records of a collection

Body

dataarray of records (all of)

dataobject

idinteger

collection_idstring (id)

metametadata (object)

filterstring

sort_bystring

sort_orderenum

ascdesc

countinteger

total_pagesinteger

current_pageinteger

forminteger

last_pageinteger

pathstring

per_pageinteger

tointeger

totalinteger

Request

Response

Save a new record in a collection

Create a new record in a Collection.

POST/api/1.0/collections/{collection_id}/records

Path parameters

collection_id*string

ID of the collection

Body

dataobject

Response

success

Body

dataobject

idinteger

collection_idstring (id)

Request

Response

Get single record of a collection

Get a single record of a Collection.

GET/api/1.0/collections/{collection_id}/records/{record_id}

Path parameters

collection_id*string

ID of the collection

record_id*string

ID of the record to return

Response

Successfully found the record

Body

dataobject

idinteger

collection_idstring (id)

Request

Response

Update a record

Update a record in a Collection.

PUT/api/1.0/collections/{collection_id}/records/{record_id}

Path parameters

collection_id*string

ID of collection

record_id*string

ID of the record

Body

dataobject

Response

success

Request

Delete a collection record

Delete a record of a Collection.

DELETE/api/1.0/collections/{collection_id}/records/{record_id}

Path parameters

collection_id*string

ID of collection

record_id*string

ID of record in collection

Response

success

Request

Partial update of a record

Implements a partial update of a record in a Collection.

PATCH/api/1.0/collections/{collection_id}/records/{record_id}

Path parameters

collection_id*string

ID of collection

record_id*string

ID of the record

Body

namestring

descriptionstring

custom_titlestring

create_screen_idstring (id)

read_screen_idstring (id)

update_screen_idstring (id)

signal_createboolean

signal_updateboolean

signal_deleteboolean

Response

success

Request

Data Connectors

Returns all Data Connectors categories that the user has access to

Display a listing of the Data Connector Categories.

GET/api/1.0/data_source_categories

Query parameters

filterstring

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

order_bystring

Field to order results by

order_directionenum

ascdesc

per_pageinteger

Response

list of Data Connectors categories

Body

dataarray of DataSourceCategory (object)

namestring

Represents a business data Source category definition.

statusenum

ACTIVEINACTIVE

idstring (id)

created_atstring (date-time)

updated_atstring (date-time)

metaobject

filterstring

sort_bystring

sort_orderenum

ascdesc

countinteger

total_pagesinteger

current_pageinteger

forminteger

last_pageinteger

pathstring

per_pageinteger

tointeger

totalinteger

Request

Response

Save a new Data Connector Category

Store a newly created Data Connector Category in storage

POST/api/1.0/data_source_categories

Body

namestring

Represents a business data Source category definition.

statusenum

ACTIVEINACTIVE

Response

success

Body

namestring

Represents a business data Source category definition.

statusenum

ACTIVEINACTIVE

idstring (id)

created_atstring (date-time)

updated_atstring (date-time)

Request

Response

Get single Data Connector category by ID

Display the specified data Source category.

GET/api/1.0/data_source_categories/{data_source_category_id}

Path parameters

data_source_category_id*string

ID of Data Connector category to return

Response

Successfully found the Data Connector

Body

namestring

Represents a business data Source category definition.

statusenum

ACTIVEINACTIVE

idstring (id)

created_atstring (date-time)

updated_atstring (date-time)

Request

Response

Update a Data Connector Category

Updates the current element

PUT/api/1.0/data_source_categories/{data_source_category_id}

Path parameters

data_source_category_id*string

ID of Data Connector category to return

Body

namestring

Represents a business data Source category definition.

statusenum

ACTIVEINACTIVE

Response

success

Body

namestring

Represents a business data Source category definition.

statusenum

ACTIVEINACTIVE

idstring (id)

created_atstring (date-time)

updated_atstring (date-time)

Request

Response

Delete a Data Connector category

Remove the specified resource from storage.

DELETE/api/1.0/data_source_categories/{data_source_category_id}

Path parameters

data_source_category_id*string

ID of Data Connector category to return

Response

success

Request

Returns all Data Connectors that the user has access to

Get the list of records of a Data Connector

GET/api/1.0/data_sources

Query parameters

filterstring

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

order_bystring

Field to order results by

order_directionenum

ascdesc

per_pageinteger

includestring

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

Response

list of Data Connectors

Body

dataarray of dataSource (object)

idstring (id)

Class DataSource

namestring

descriptionstring

endpointsstring

mappingsstring

authtypestring

credentialsstring

statusstring

data_source_category_idstring

created_atstring (date-time)

updated_atstring (date-time)

metaobject

filterstring

sort_bystring

sort_orderenum

ascdesc

countinteger

total_pagesinteger

current_pageinteger

forminteger

last_pageinteger

pathstring

per_pageinteger

tointeger

totalinteger

Request

Response

Save a new Data Connector

Create a new Data Connector.

POST/api/1.0/data_sources

Body

idstring (id)

Class DataSource

namestring

descriptionstring

endpointsstring

mappingsstring

authtypestring

credentialsstring

statusstring

data_source_category_idstring

Response

success

Body

idstring (id)

Class DataSource

namestring

descriptionstring

endpointsstring

mappingsstring

authtypestring

credentialsstring

statusstring

data_source_category_idstring

created_atstring (date-time)

updated_atstring (date-time)

Request

Response

Get single Data Connector by ID

Get a single Data Connector.

GET/api/1.0/data_sources/data_source_id

Path parameters

data_source_id*string

ID of Data Connector to return

Response

Successfully found the Data Connector

Body

idstring (id)

Class DataSource

namestring

descriptionstring

endpointsstring

mappingsstring

authtypestring

credentialsstring

statusstring

data_source_category_idstring

created_atstring (date-time)

updated_atstring (date-time)

Request

Response

Update a Data Connector

Update a Data Connector.

PUT/api/1.0/data_sources/data_source_id

Path parameters

data_source_id*string

ID of Data Connector to return

Body

idstring (id)

Class DataSource

namestring

descriptionstring

endpointsstring

mappingsstring

authtypestring

credentialsstring

statusstring

data_source_category_idstring

Response

success

Body

idstring (id)

Class DataSource

namestring

descriptionstring

endpointsstring

mappingsstring

authtypestring

credentialsstring

statusstring

data_source_category_idstring

created_atstring (date-time)

updated_atstring (date-time)

Request

Response

Delete a Data Connector

Delete a Data Connector.

DELETE/api/1.0/data_sources/data_source_id

Path parameters

data_source_id*string

ID of Data Connector to return

Response

success

Body

idstring (id)

Class DataSource

namestring

descriptionstring

endpointsstring

mappingsstring

authtypestring

credentialsstring

statusstring

data_source_category_idstring

created_atstring (date-time)

updated_atstring (date-time)

Request

Response

Send a Data Connector request

Send a Data Connector request.

POST/api/1.0/data_sources/data_source_id/test

Path parameters

data_source_id*string

ID of Data Connector to return

Body

idstring (id)

Class DataSource

namestring

descriptionstring

endpointsstring

mappingsstring

authtypestring

credentialsstring

statusstring

data_source_category_idstring

Response

success

Body

idstring (id)

Class DataSource

namestring

descriptionstring

endpointsstring

mappingsstring

authtypestring

credentialsstring

statusstring

data_source_category_idstring

created_atstring (date-time)

updated_atstring (date-time)

Request

Response

execute Data Source

Execute a data Source endpoint

POST/api/1.0/requests/{request_id}/data_sources/{data_source_id}

Path parameters

request_id*string

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

data_source_id*string

ID of DataSource to be run

Body

configDataSourceCallParameters (object)

endpointstring

dataMappingarray of object

keystring

valuestring

outboundConfigarray of object

keystring

valuestring

Response

success

Body

statusinteger

responseobject

Request

Response

execute Data Source

POST/api/1.0/requests/data_sources/{data_source_id}

Path parameters

data_source_id*string

ID of DataSource to be run

Body

configDataSourceCallParameters (object)

endpointstring

dataMappingarray of object

keystring

valuestring

outboundConfigarray of object

keystring

valuestring

dataobject

Response

success

Body

statusinteger

responseobject

Request

Response

Get Data from Data Source

POST/api/1.0/requests/data_sources/{data_source_id}/resources/{endpoint}/data

Path parameters

data_source_id*string

ID of DataSource to be run

endpoint*string

Endpoint of the data source

Response

success

Body

statusinteger

responseobject

Request

Response

Scripts

API Reference for ProcessMaker Script API

Delete a script category

Remove the specified resource from storage.

DELETE/api/1.0/script_categories/{script_category_id}

Path parameters

script_category_id*string

ID of script category to return

Response

success

Request

const response = await fetch('/api/1.0/script_categories/{script_category_id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Test script code without saving it

Previews executing a script, with sample data/config data

POST/api/1.0/scripts/{script_id}/preview

Path parameters

script_id*integer

Body

dataarray of object

configarray of object

codestring

noncestring

Response

success if the script was queued

Request

const response = await fetch('/api/1.0/scripts/{script_id}/preview', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Get the response of a script execution by execution key

Get the response of a script execution

GET/api/1.0/scripts/execution/{key}

Path parameters

key*string

Response

response of a script execution

Body

any

Request

const response = await fetch('/api/1.0/scripts/execution/{key}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Delete a script

Delete a script in a process.

DELETE/api/1.0/scripts/{script_id}

Path parameters

script_id*string

ID of script to return

Response

success

Request

const response = await fetch('/api/1.0/scripts/{script_id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Create a script executor

POST/api/1.0/script-executors

Body

titlestring

Represents an Eloquent model of a Script Executor

descriptionstring

languagestring

configstring

Response

success

Body

statusstring

idstring

Request

const response = await fetch('/api/1.0/script-executors', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

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

Delete a script executor

DELETE/api/1.0/script-executors/{script_executor}

Path parameters

script_executor*string

ID of script executor to return

Response

success

Body

statusstring

Request

const response = await fetch('/api/1.0/script-executors/{script_executor}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

{
  "status": "text"
}

Cancel a script executor

POST/api/1.0/script-executors/cancel

Body

pidFilestring

Response

success

Body

statusstring

idstring

Request

const response = await fetch('/api/1.0/script-executors/cancel', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

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

Saved Search

Delete a saved search chart

Delete a SavedSearchChart.

DELETE/api/1.0/saved-searches/charts/{chart_id}

Path parameters

chart_id*string

ID of chart to return

Response

success

Request

Returns all columns associated with a Saved Search

Display a listing of columns.

GET/api/1.0/saved-searches/{savedSearchId}/columns

Path parameters

savedSearchId*string

ID of saved search to return

Query parameters

includearray of enum

Include specific categories. Comma separated list.

itemsenum

currentdefaultavailabledata

Response

Categorized list of columns

Body

currentarray of columns (object)

labelstring

fieldstring

sortableboolean

defaultboolean

formatstring

maskstring

defaultarray of columns (object)

labelstring

fieldstring

sortableboolean

defaultboolean

formatstring

maskstring

availablearray of columns (object)

labelstring

fieldstring

sortableboolean

defaultboolean

formatstring

maskstring

dataarray of columns (object)

labelstring

fieldstring

sortableboolean

defaultboolean

formatstring

maskstring

Request

Response

Returns all users

Display a listing of the resource.

GET/api/1.0/saved-searches/{savedSearchId}/users

Path parameters

savedSearchId*string

ID of saved search to return

Query parameters

filterstring

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

order_bystring

Field to order results by

order_directionenum

ascdesc

per_pageinteger

includestring

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

Response

list of users

Body

dataarray of users (all of)

emailstring (email)

The attributes that are mass assignable.

firstnamestring

lastnamestring

usernamestring

passwordstring

addressstring

citystring

statestring

postalstring

countrystring

phonestring

faxstring

cellstring

titlestring

timezonestring

datetime_formatstring

languagestring

is_administratorboolean

expires_atstring

loggedin_atstring

remember_tokenstring

statusenum

ACTIVEINACTIVESCHEDULEDOUT_OF_OFFICE

fullnamestring

avatarstring

mediaarray of media (object)

idinteger (id)

Represents media files stored in the database

model_idinteger (id)

model_typestring (id)

collection_namestring

namestring

file_namestring

mime_typestring

diskstring

sizeinteger

manipulationsobject

custom_propertiesobject

responsive_imagesobject

order_columninteger

created_atstring (date-time)

updated_atstring (date-time)

birthdatestring (date)

delegation_user_idstring (id)

manager_idstring (id)

metaobject

Other propertiesany

force_change_passwordboolean

idinteger

created_atstring (date-time)

updated_atstring (date-time)

deleted_atstring (date-time)

metametadata (object)

filterstring

sort_bystring

sort_orderenum

ascdesc

countinteger

total_pagesinteger

current_pageinteger

forminteger

last_pageinteger

pathstring

per_pageinteger

tointeger

totalinteger

Request

Response

Returns all groups that the user has access to

Display a listing of the resource.

GET/api/1.0/saved-searches/{savedSearchId}/groups

Query parameters

order_bystring

Field to order results by

order_directionenum

ascdesc

per_pageinteger

includestring

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

Response

list of groups

Body

dataarray of groups (all of)

namestring

Represents a group definition.

descriptionstring

manager_idinteger (id)

statusenum

ACTIVEINACTIVE

created_atstring (date-time)

updated_atstring (date-time)

idstring (id)

metametadata (object)

filterstring

sort_bystring

sort_orderenum

ascdesc

countinteger

total_pagesinteger

current_pageinteger

forminteger

last_pageinteger

pathstring

per_pageinteger

tointeger

totalinteger

Request

Response

Delete a saved search

Delete a SavedSearch.

DELETE/api/1.0/saved-searches/{saved_search_id}

Path parameters

saved_search_id*string

ID of saved search to return

Response

success

Request

Returns all icons for saved searches

Get a list of icons available for SavedSearches.

GET/api/1.0/saved-searches/icons

Query parameters

per_pageinteger

Response

list of icons for saved searches

Body

dataarray of SavedSearchIcon (object)

namestring

valuestring

metaobject

filterstring

sort_bystring

sort_orderenum

ascdesc

countinteger

total_pagesinteger

current_pageinteger

forminteger

last_pageinteger

pathstring

per_pageinteger

tointeger

totalinteger

Request

Response

Versions

Create or update a new setting

Create a new Settings css-override

POST/api/1.0/customize-ui

Body

variablesstring

sansSerifFontstring

Response

success

Body

keystring

Class Settings

configarray of object

namestring

helperstring

groupstring

formatstring

hiddenboolean

readonlyboolean

variablesstring

sansSerifFontstring

idstring (id)

created_atstring (date-time)

updated_atstring (date-time)

Request

Response

Return all version History according to the model

Get the list of records of Version History

GET/api/1.0/version_histories

Query parameters

filterstring

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

order_bystring

Field to order results by

order_directionenum

ascdesc

per_pageinteger

includestring

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

Response

list of Version History

Body

dataarray of versionHistory (object)

versionable_idinteger

Class VersionHistoryCollection

versionable_typestring

namestring

subjectstring

descriptionstring

statusenum

ACTIVEINACTIVE

created_atstring (date-time)

updated_atstring (date-time)

metaobject

filterstring

sort_bystring

sort_orderenum

ascdesc

countinteger

total_pagesinteger

current_pageinteger

forminteger

last_pageinteger

pathstring

per_pageinteger

tointeger

totalinteger

Request

Response

Save a new Version History

Create a new Version History.

POST/api/1.0/version_histories

Body

versionable_idinteger

Class VersionHistoryCollection

versionable_typestring

namestring

subjectstring

descriptionstring

statusenum

ACTIVEINACTIVE

Response

success

Body

versionable_idinteger

Class VersionHistoryCollection

versionable_typestring

namestring

subjectstring

descriptionstring

statusenum

ACTIVEINACTIVE

created_atstring (date-time)

updated_atstring (date-time)

Request

Response

Get single Version History by ID

Get a single Version History.

GET/api/1.0/version_histories/{version_history_id}

Path parameters

version_history_id*string

ID of Version History to return

Response

Successfully found the Version History

Body

versionable_idinteger

Class VersionHistoryCollection

versionable_typestring

namestring

subjectstring

descriptionstring

statusenum

ACTIVEINACTIVE

created_atstring (date-time)

updated_atstring (date-time)

Request

Response

Update a Version History

Update a Version History.

PUT/api/1.0/version_histories/{version_history_id}

Path parameters

version_history_id*string

ID of Version History to return

Body

versionable_idinteger

Class VersionHistoryCollection

versionable_typestring

namestring

subjectstring

descriptionstring

statusenum

ACTIVEINACTIVE

Response

success

Body

versionable_idinteger

Class VersionHistoryCollection

versionable_typestring

namestring

subjectstring

descriptionstring

statusenum

ACTIVEINACTIVE

created_atstring (date-time)

updated_atstring (date-time)

Request

Response

Delete a Version History

Delete a Version History.

DELETE/api/1.0/version_histories/{version_history_id}

Path parameters

version_history_id*string

ID of Version History to return

Response

success

Body

versionable_idinteger

Class VersionHistoryCollection

versionable_typestring

namestring

subjectstring

descriptionstring

statusenum

ACTIVEINACTIVE

created_atstring (date-time)

updated_atstring (date-time)

Request

Response

Clone a new Version History

Clone a new Version History.

POST/api/1.0/version_histories/clone

Body

versionable_idinteger

Class VersionHistoryCollection

versionable_typestring

namestring

subjectstring

descriptionstring

statusenum

ACTIVEINACTIVE

Response

success

Body

versionable_idinteger

Class VersionHistoryCollection

versionable_typestring

namestring

subjectstring

descriptionstring

statusenum

ACTIVEINACTIVE

created_atstring (date-time)

updated_atstring (date-time)

Request

Response

Decision Engine

Returns all Decision Tables categories that the user has access to

Display a listing of the Decision Tables Categories.

GET/api/1.0/decision_table_categories

Query parameters

filterstring

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

order_bystring

Field to order results by

order_directionenum

ascdesc

per_pageinteger

Response

list of Decision Tables categories

Body

dataarray of DecisionTableCategory (object)

namestring

Represents a business decision Table category definition.

statusenum

ACTIVEINACTIVE

idstring (id)

created_atstring (date-time)

updated_atstring (date-time)

metaobject

filterstring

sort_bystring

sort_orderenum

ascdesc

countinteger

total_pagesinteger

current_pageinteger

forminteger

last_pageinteger

pathstring

per_pageinteger

tointeger

totalinteger

Request

Response

Save a new Decision Table Category

Store a newly created Decision Tables Category in storage

POST/api/1.0/decision_table_categories

Body

namestring

Represents a business decision Table category definition.

statusenum

ACTIVEINACTIVE

Response

success

Body

namestring

Represents a business decision Table category definition.

statusenum

ACTIVEINACTIVE

idstring (id)

created_atstring (date-time)

updated_atstring (date-time)

Request

Response

Get single Decision Table category by ID

Display the specified decision Tables category.

GET/api/1.0/decision_table_categories/{decision_table_categories_id}

Path parameters

decision_table_categories_id*string

ID of Decision Table category to return

Response

Successfully found the Decision Table

Body

namestring

Represents a business decision Table category definition.

statusenum

ACTIVEINACTIVE

idstring (id)

created_atstring (date-time)

updated_atstring (date-time)

Request

Response

Update a Decision Table Category

Updates the current element

PUT/api/1.0/decision_table_categories/{decision_table_categories_id}

Path parameters

decision_table_categories_id*string

ID of Decision Table category to return

Body

namestring

Represents a business decision Table category definition.

statusenum

ACTIVEINACTIVE

Response

success

Body

namestring

Represents a business decision Table category definition.

statusenum

ACTIVEINACTIVE

idstring (id)

created_atstring (date-time)

updated_atstring (date-time)

Request

Response

Delete a Decision Table category

Remove the specified resource from storage.

DELETE/api/1.0/decision_table_categories/{decision_table_categories_id}

Path parameters

decision_table_categories_id*string

ID of Decision Table category to return

Response

success

Request

Returns all Decision tables that the user has access to

Display a listing of the resource.

GET/api/1.0/decision_tables

Query parameters

filterstring

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

order_bystring

Field to order results by

order_directionenum

ascdesc

per_pageinteger

includestring

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

Response

list of Decision Tables

Body

dataarray of decisionTable (object)

idstring (id)

Class Screen

namestring

descriptionstring

definitionstring

decision_table_categories_idstring

created_atstring (date-time)

updated_atstring (date-time)

metaobject

filterstring

sort_bystring

sort_orderenum

ascdesc

countinteger

total_pagesinteger

current_pageinteger

forminteger

last_pageinteger

pathstring

per_pageinteger

tointeger

totalinteger

Request

Response

Save a new Decision Table

Store a newly created resource in storage.

POST/api/1.0/decision_tables

Body

idstring (id)

Class Screen

namestring

descriptionstring

definitionstring

decision_table_categories_idstring

Response

success

Body

idstring (id)

Class Screen

namestring

descriptionstring

definitionstring

decision_table_categories_idstring

created_atstring (date-time)

updated_atstring (date-time)

Request

Response

Get single Decision Table by ID

Display the specified resource.

GET/api/1.0/decision_tables/{decision_table_id}

Path parameters

decision_table_id*string

ID of Decision Table to return

Response

Successfully found the Decision Table

Body

idstring (id)

Class Screen

namestring

descriptionstring

definitionstring

decision_table_categories_idstring

created_atstring (date-time)

updated_atstring (date-time)

Request

Response

Update a Decision Table

Update a Decision table

PUT/api/1.0/decision_tables/{decision_table_id}

Path parameters

decision_table_id*string

ID of Decision Table to return

Body

idstring (id)

Class Screen

namestring

descriptionstring

definitionstring

decision_table_categories_idstring

Response

success

Body

idstring (id)

Class Screen

namestring

descriptionstring

definitionstring

decision_table_categories_idstring

created_atstring (date-time)

updated_atstring (date-time)

Request

Response

Delete a Decision Table

Delete a Decision tables

DELETE/api/1.0/decision_tables/{decision_table_id}

Path parameters

decision_table_id*string

ID of Decision Table to return

Response

success

Body

idstring (id)

Class Screen

namestring

descriptionstring

definitionstring

decision_table_categories_idstring

created_atstring (date-time)

updated_atstring (date-time)

Request

Response

duplicate a Decision Table

duplicate a Decision table.

PUT/api/1.0/decision_tables/{decision_table_id}/duplicate

Path parameters

decision_table_id*string

ID of Decision Table to return

Body

idstring (id)

Class Screen

namestring

descriptionstring

definitionstring

decision_table_categories_idstring

Response

success

Body

idstring (id)

Class Screen

namestring

descriptionstring

definitionstring

decision_table_categories_idstring

created_atstring (date-time)

updated_atstring (date-time)

Request

Response

Import a new decision table

Import a Decision table from excel

POST/api/1.0/decision_tables/{decision_table_id}/excel-import

Path parameters

decision_table_id*string

ID of Decision Table to return

Body

filestring (binary)

file to import

Response

success

Body

statusobject

Request

Response

Export a single Decision Table by ID

Export the specified screen.

POST/api/1.0/decision_tables/{decision_table_id}/export

Path parameters

decision_table_id*string

ID of Decision Table to return

Response

Successfully exported the decision table

Body

urlstring

Request

Response

Import a new Decision Table

Import the specified Decision Table.

POST/api/1.0/decision_tables/import

Body

filestring (binary)

file to import

Response

success

Body

statusobject

Request

Response

Returns all columns associated with a Saved Search

Display a listing of columns.

GET/api/1.0/saved-searches/{savedSearchId}/columns

Path parameters

savedSearchId*string

ID of saved search to return

Query parameters

includearray of enum

Include specific categories. Comma separated list.

itemsenum

currentdefaultavailabledata

Response

Categorized list of columns

Body

currentarray of columns (object)

labelstring

fieldstring

sortableboolean

defaultboolean

formatstring

maskstring

defaultarray of columns (object)

labelstring

fieldstring

sortableboolean

defaultboolean

formatstring

maskstring

availablearray of columns (object)

labelstring

fieldstring

sortableboolean

defaultboolean

formatstring

maskstring

dataarray of columns (object)

labelstring

fieldstring

sortableboolean

defaultboolean

formatstring

maskstring

Request

Response

Returns all records

Get the list of records of a collection.

GET/api/1.0/collections/{collection_id}/records

Path parameters

collection_id*string

ID of collection to get records for

Query parameters

pmqlstring

per_pageinteger

filterstring

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

order_bystring

Field to order results by

order_directionenum

ascdesc

includestring

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

Response

list of records of a collection

Body

dataarray of records (all of)

dataobject

idinteger

collection_idstring (id)

metametadata (object)

filterstring

sort_bystring

sort_orderenum

ascdesc

countinteger

total_pagesinteger

current_pageinteger

forminteger

last_pageinteger

pathstring

per_pageinteger

tointeger

totalinteger

Request

Response

Returns all Data Connectors that the user has access to

Get the list of records of a Data Connector

GET/api/1.0/data_sources

Query parameters

filterstring

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

order_bystring

Field to order results by

order_directionenum

ascdesc

per_pageinteger

includestring

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

Response

list of Data Connectors

Body

dataarray of dataSource (object)

idstring (id)

Class DataSource

namestring

descriptionstring

endpointsstring

mappingsstring

authtypestring

credentialsstring

statusstring

data_source_category_idstring

created_atstring (date-time)

updated_atstring (date-time)

metaobject

filterstring

sort_bystring

sort_orderenum

ascdesc

countinteger

total_pagesinteger

current_pageinteger

forminteger

last_pageinteger

pathstring

per_pageinteger

tointeger

totalinteger

Request

Response

Return all version History according to the model

Get the list of records of Version History

GET/api/1.0/version_histories

Query parameters

filterstring

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

order_bystring

Field to order results by

order_directionenum

ascdesc

per_pageinteger

includestring

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

Response

list of Version History

Body

dataarray of versionHistory (object)

versionable_idinteger

Class VersionHistoryCollection

versionable_typestring

namestring

subjectstring

descriptionstring

statusenum

ACTIVEINACTIVE

created_atstring (date-time)

updated_atstring (date-time)

metaobject

filterstring

sort_bystring

sort_orderenum

ascdesc

countinteger

total_pagesinteger

current_pageinteger

forminteger

last_pageinteger

pathstring

per_pageinteger

tointeger

totalinteger

Request

Response

Returns all Decision tables that the user has access to

Display a listing of the resource.

GET/api/1.0/decision_tables

Query parameters

filterstring

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

order_bystring

Field to order results by

order_directionenum

ascdesc

per_pageinteger

includestring

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

Response

list of Decision Tables

Body

dataarray of decisionTable (object)

idstring (id)

Class Screen

namestring

descriptionstring

definitionstring

decision_table_categories_idstring

created_atstring (date-time)

updated_atstring (date-time)

metaobject

filterstring

sort_bystring

sort_orderenum

ascdesc

countinteger

total_pagesinteger

current_pageinteger

forminteger

last_pageinteger

pathstring

per_pageinteger

tointeger

totalinteger

Request

Response

Returns all Data Connectors categories that the user has access to

Display a listing of the Data Connector Categories.

GET/api/1.0/data_source_categories

Query parameters

filterstring

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

order_bystring

Field to order results by

order_directionenum

ascdesc

per_pageinteger

Response

list of Data Connectors categories

Body

dataarray of DataSourceCategory (object)

namestring

Represents a business data Source category definition.

statusenum

ACTIVEINACTIVE

idstring (id)

created_atstring (date-time)

updated_atstring (date-time)

metaobject

filterstring

sort_bystring

sort_orderenum

ascdesc

countinteger

total_pagesinteger

current_pageinteger

forminteger

last_pageinteger

pathstring

per_pageinteger

tointeger

totalinteger

Request

Response

Returns all Decision Tables categories that the user has access to

Display a listing of the Decision Tables Categories.

GET/api/1.0/decision_table_categories

Query parameters

filterstring

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

order_bystring

Field to order results by

order_directionenum

ascdesc

per_pageinteger

Response

list of Decision Tables categories

Body

dataarray of DecisionTableCategory (object)

namestring

Represents a business decision Table category definition.

statusenum

ACTIVEINACTIVE

idstring (id)

created_atstring (date-time)

updated_atstring (date-time)

metaobject

filterstring

sort_bystring

sort_orderenum

ascdesc

countinteger

total_pagesinteger

current_pageinteger

forminteger

last_pageinteger

pathstring

per_pageinteger

tointeger

totalinteger

Request

Response

Returns all collections that the user has access to

Get a list of Collections.

GET/api/1.0/collections

Query parameters

filterstring

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

order_bystring

Field to order results by

order_directionenum

ascdesc

per_pageinteger

includestring

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

Response

list of collections

Body

dataarray of collections (all of)

namestring

descriptionstring

custom_titlestring

create_screen_idstring (id)

read_screen_idstring (id)

update_screen_idstring (id)

signal_createboolean

signal_updateboolean

signal_deleteboolean

idinteger

created_atstring (date-time)

updated_atstring (date-time)

created_by_idstring (id)

updated_by_idstring (id)

columnsarray of object

metametadata (object)

filterstring

sort_bystring

sort_orderenum

ascdesc

countinteger

total_pagesinteger

current_pageinteger

forminteger

last_pageinteger

pathstring

per_pageinteger

tointeger

totalinteger

Request

Response

Returns all groups that the user has access to

Display a listing of the resource.

GET/api/1.0/saved-searches/{savedSearchId}/groups

Query parameters

order_bystring

Field to order results by

order_directionenum

ascdesc

per_pageinteger

includestring

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

Response

list of groups

Body

dataarray of groups (all of)

namestring

Represents a group definition.

descriptionstring

manager_idinteger (id)

statusenum

ACTIVEINACTIVE

created_atstring (date-time)

updated_atstring (date-time)

idstring (id)

metametadata (object)

filterstring

sort_bystring

sort_orderenum

ascdesc

countinteger

total_pagesinteger

current_pageinteger

forminteger

last_pageinteger

pathstring

per_pageinteger

tointeger

totalinteger

Request

Response

Returns all users

Display a listing of the resource.

GET/api/1.0/saved-searches/{savedSearchId}/users

Path parameters

savedSearchId*string

ID of saved search to return

Query parameters

filterstring

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

order_bystring

Field to order results by

order_directionenum

ascdesc

per_pageinteger

includestring

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

Response

list of users

Body

dataarray of users (all of)

emailstring (email)

The attributes that are mass assignable.

firstnamestring

lastnamestring

usernamestring

passwordstring

addressstring

citystring

statestring

postalstring

countrystring

phonestring

faxstring

cellstring

titlestring

timezonestring

datetime_formatstring

languagestring

is_administratorboolean

expires_atstring

loggedin_atstring

remember_tokenstring

statusenum

ACTIVEINACTIVESCHEDULEDOUT_OF_OFFICE

fullnamestring

avatarstring

mediaarray of media (object)

idinteger (id)

Represents media files stored in the database

model_idinteger (id)

model_typestring (id)

collection_namestring

namestring

file_namestring

mime_typestring

diskstring

sizeinteger

manipulationsobject

custom_propertiesobject

responsive_imagesobject

order_columninteger

created_atstring (date-time)

updated_atstring (date-time)

birthdatestring (date)

delegation_user_idstring (id)

manager_idstring (id)

metaobject

Other propertiesany

force_change_passwordboolean

idinteger

created_atstring (date-time)

updated_atstring (date-time)

deleted_atstring (date-time)

metametadata (object)

filterstring

sort_bystring

sort_orderenum

ascdesc

countinteger

total_pagesinteger

current_pageinteger

forminteger

last_pageinteger

pathstring

per_pageinteger

tointeger

totalinteger

Request

Response

{
  "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": false,
      "expires_at": "text",
      "loggedin_at": "text",
      "remember_token": "text",
      "status": "ACTIVE",
      "fullname": "text",
      "avatar": "text",
      "media": [
        {
          "id": 0,
          "model_id": 0,
          "model_type": "text",
          "collection_name": "text",
          "name": "text",
          "file_name": "text",
          "mime_type": "text",
          "disk": "text",
          "size": 0,
          "order_column": 0,
          "created_at": "2025-01-02T16:36:41.753Z",
          "updated_at": "2025-01-02T16:36:41.753Z"
        }
      ],
      "birthdate": "2025-01-02",
      "delegation_user_id": "text",
      "manager_id": "text",
      "force_change_password": false,
      "id": 0,
      "created_at": "2025-01-02T16:36:41.753Z",
      "updated_at": "2025-01-02T16:36:41.753Z",
      "deleted_at": "2025-01-02T16:36:41.753Z"
    }
  ],
  "meta": {
    "filter": "text",
    "sort_by": "text",
    "sort_order": "asc",
    "count": 0,
    "total_pages": 0,
    "current_page": 0,
    "form": 0,
    "last_page": 0,
    "path": "text",
    "per_page": 0,
    "to": 0,
    "total": 0
  }
}

Create or update a new setting

Create a new Settings css-override

POST/api/1.0/customize-ui

Body

variablesstring

sansSerifFontstring

Response

success

Body

keystring

Class Settings

configarray of object

namestring

helperstring

groupstring

formatstring

hiddenboolean

readonlyboolean

variablesstring

sansSerifFontstring

idstring (id)

created_atstring (date-time)

updated_atstring (date-time)

Request

const response = await fetch('/api/1.0/customize-ui', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "key": "text",
  "config": [],
  "name": "text",
  "helper": "text",
  "group": "text",
  "format": "text",
  "hidden": false,
  "readonly": false,
  "variables": "text",
  "sansSerifFont": "text",
  "id": "text",
  "created_at": "2025-01-02T16:36:41.753Z",
  "updated_at": "2025-01-02T16:36:41.753Z"
}

Create or update a new setting

Create a new Settings css-override

POST/api/1.0/customize-ui

Body

variablesstring

sansSerifFontstring

Response

success

Body

keystring

Class Settings

configarray of object

namestring

helperstring

groupstring

formatstring

hiddenboolean

readonlyboolean

variablesstring

sansSerifFontstring

idstring (id)

created_atstring (date-time)

updated_atstring (date-time)

Request

const response = await fetch('/api/1.0/customize-ui', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "key": "text",
  "config": [],
  "name": "text",
  "helper": "text",
  "group": "text",
  "format": "text",
  "hidden": false,
  "readonly": false,
  "variables": "text",
  "sansSerifFont": "text",
  "id": "text",
  "created_at": "2025-01-02T16:36:41.753Z",
  "updated_at": "2025-01-02T16:36:41.753Z"
}

Create or update a new setting

Create a new Settings css-override

POST/api/1.0/customize-ui

Body

variablesstring

sansSerifFontstring

Response

success

Body

keystring

Class Settings

configarray of object

namestring

helperstring

groupstring

formatstring

hiddenboolean

readonlyboolean

variablesstring

sansSerifFontstring

idstring (id)

created_atstring (date-time)

updated_atstring (date-time)

Request

const response = await fetch('/api/1.0/customize-ui', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "key": "text",
  "config": [],
  "name": "text",
  "helper": "text",
  "group": "text",
  "format": "text",
  "hidden": false,
  "readonly": false,
  "variables": "text",
  "sansSerifFont": "text",
  "id": "text",
  "created_at": "2025-01-02T16:36:41.753Z",
  "updated_at": "2025-01-02T16:36:41.753Z"
}

Create or update a new setting

Create a new Settings css-override

POST/api/1.0/customize-ui

Body

variablesstring

sansSerifFontstring

Response

success

Body

keystring

Class Settings

configarray of object

namestring

helperstring

groupstring

formatstring

hiddenboolean

readonlyboolean

variablesstring

sansSerifFontstring

idstring (id)

created_atstring (date-time)

updated_atstring (date-time)

Request

const response = await fetch('/api/1.0/customize-ui', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "key": "text",
  "config": [],
  "name": "text",
  "helper": "text",
  "group": "text",
  "format": "text",
  "hidden": false,
  "readonly": false,
  "variables": "text",
  "sansSerifFont": "text",
  "id": "text",
  "created_at": "2025-01-02T16:36:41.753Z",
  "updated_at": "2025-01-02T16:36:41.753Z"
}

Create or update a new setting

Create a new Settings css-override

POST/api/1.0/customize-ui

Body

variablesstring

sansSerifFontstring

Response

success

Body

keystring

Class Settings

configarray of object

namestring

helperstring

groupstring

formatstring

hiddenboolean

readonlyboolean

variablesstring

sansSerifFontstring

idstring (id)

created_atstring (date-time)

updated_atstring (date-time)

Request

const response = await fetch('/api/1.0/customize-ui', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "key": "text",
  "config": [],
  "name": "text",
  "helper": "text",
  "group": "text",
  "format": "text",
  "hidden": false,
  "readonly": false,
  "variables": "text",
  "sansSerifFont": "text",
  "id": "text",
  "created_at": "2025-01-02T16:36:41.753Z",
  "updated_at": "2025-01-02T16:36:41.753Z"
}

Delete all media associated with a request

Remove the specified resource from storage.

DELETE/api/1.0/requests/{request_id}/files/{file_id}

Path parameters

file_id*integer

ID of the file

request_id*string

ID of the request

Response

success

Request

const response = await fetch('/api/1.0/requests/{request_id}/files/{file_id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

{
  "error": "text"
}

Get a file uploaded to a request

Display the specified resource.

GET/api/1.0/requests/{request_id}/files/{file_id}

Path parameters

request_id*integer

ID of the request

file_id*integer

ID of the file to return

Response

File stream

Body

string (binary)

Request

const response = await fetch('/api/1.0/requests/{request_id}/files/{file_id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

binary

Save a new media file to a request

Store a newly created resource in storage.

POST/api/1.0/requests/{request_id}/files

Path parameters

request_id*integer

ID of the request

Query parameters

data_namestring

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

Body

filestring (binary)

save a new media file

Response

success

Body

messagestring

fileUploadIdinteger

Request

const response = await fetch('/api/1.0/requests/{request_id}/files', {
    method: 'POST',
    headers: {
      "Content-Type": "multipart/form-data"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

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

Create a script executor

POST/api/1.0/script-executors

Body

titlestring

Represents an Eloquent model of a Script Executor

descriptionstring

languagestring

configstring

Response

success

Body

statusstring

idstring

Request

const response = await fetch('/api/1.0/script-executors', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

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

Get single process category by ID

Display the specified Process category.

GET/api/1.0/process_categories/{process_category_id}

Path parameters

process_category_id*integer

ID of process category to return

Response

Successfully found the process

Body

namestring

Represents a business process category definition.

statusenum

ACTIVEINACTIVE

idstring (id)

created_atstring (date-time)

updated_atstring (date-time)

Request

const response = await fetch('/api/1.0/process_categories/{process_category_id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "name": "text",
  "status": "ACTIVE",
  "id": "text",
  "created_at": "2025-01-02T16:36:41.753Z",
  "updated_at": "2025-01-02T16:36:41.753Z"
}

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

Return an environment variable instance Using implicit model binding, will automatically return 404 if variable now found

GET/api/1.0/environment_variables/{environment_variable_id}

Path parameters

environment_variable_id*integer

ID of environment_variables to return

Response

success

Body

namestring

descriptionstring

valuestring

idinteger (id)

created_atstring (date-time)

updated_atstring (date-time)

Request

const response = await fetch('/api/1.0/environment_variables/{environment_variable_id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "name": "text",
  "description": "text",
  "value": "text",
  "id": 0,
  "created_at": "2025-01-02T16:36:41.753Z",
  "updated_at": "2025-01-02T16:36:41.753Z"
}

Get single screen category by ID

Display the specified screen category.

GET/api/1.0/screen_categories/{screen_category_id}

Path parameters

screen_category_id*string

ID of screen category to return

Response

Successfully found the screen

Body

namestring

Represents a business screen category definition.

statusenum

ACTIVEINACTIVE

idstring (id)

created_atstring (date-time)

updated_atstring (date-time)

Request

const response = await fetch('/api/1.0/screen_categories/{screen_category_id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "name": "text",
  "status": "ACTIVE",
  "id": "text",
  "created_at": "2025-01-02T16:36:41.753Z",
  "updated_at": "2025-01-02T16:36:41.753Z"
}

Get single script category by ID

Display the specified script category.

GET/api/1.0/script_categories/{script_category_id}

Path parameters

script_category_id*string

ID of script category to return

Response

Successfully found the script

Body

namestring

Represents a business script category definition.

statusenum

ACTIVEINACTIVE

idstring (id)

created_atstring (date-time)

updated_atstring (date-time)

Request

const response = await fetch('/api/1.0/script_categories/{script_category_id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "name": "text",
  "status": "ACTIVE",
  "id": "text",
  "created_at": "2025-01-02T16:36:41.753Z",
  "updated_at": "2025-01-02T16:36:41.753Z"
}

Import a new process

Import the specified process.

POST/api/1.0/processes/import

Body

filestring (binary)

file to import

Response

success

Body

process_category_idinteger (id)

Represents a business process definition.

namestring

descriptionstring

statusenum

ACTIVEINACTIVEARCHIVED

pause_timer_startinteger

cancel_screen_idinteger

has_timer_start_eventsboolean

request_detail_screen_idinteger (id)

is_validinteger

package_keystring

start_eventsarray of ProcessStartEvents (object)

eventDefinitionsobject

parallelMultipleboolean

outgoingobject

incomingobject

idstring

namestring

warningsstring

self_service_tasksobject

signal_eventsarray of object

categoryobject

manager_idinteger (id)

statusarray of object

assignablearray of object

processany

Request

const response = await fetch('/api/1.0/processes/import', {
    method: 'POST',
    headers: {
      "Content-Type": "multipart/form-data"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "process_category_id": 0,
  "name": "text",
  "description": "text",
  "status": [],
  "pause_timer_start": 0,
  "cancel_screen_id": 0,
  "has_timer_start_events": false,
  "request_detail_screen_id": 0,
  "is_valid": 0,
  "package_key": "text",
  "start_events": [
    {
      "parallelMultiple": false,
      "id": "text",
      "name": "text"
    }
  ],
  "warnings": "text",
  "signal_events": [],
  "manager_id": 0,
  "assignable": []
}

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

Store a newly created resource in storage.

POST/api/1.0/files

Query parameters

model_id*integer

ID of the model to which the file will be associated

model*string

Full namespaced class of the model to associate

data_namestring

Name of the variable used in a request

collectionstring

Media collection name. For requests, use 'default'

Body

filestring (binary)

save a new media file

Response

success

Body

idstring

model_idstring

file_namestring

mime_typestring

Request

const response = await fetch('/api/1.0/files?model_id=0&model=text', {
    method: 'POST',
    headers: {
      "Content-Type": "multipart/form-data"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

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

Execute script

Executes a script, with sample data/config data

POST/api/1.0/scripts/execute/{script_id}

Path parameters

script_id*integer

Body

dataarray of object

configarray of object

Response

success if the script was queued

Body

statusstring

keystring

Request

const response = await fetch('/api/1.0/scripts/execute/{script_id}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

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

Preview a screen

Get preview a screen

POST/api/1.0/screens/preview

Body

configobject

watchersobject

computedobject

custom_cssstring

Response

Successfully found the screen

Body

titlestring

Class Screen

typestring

descriptionstring

configarray of object

computedarray of object

watchersarray of object

custom_cssstring

screen_category_idstring

idstring (id)

created_atstring (date-time)

updated_atstring (date-time)

Request

const response = await fetch('/api/1.0/screens/preview', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "title": "text",
  "type": "text",
  "description": "text",
  "config": [],
  "computed": [],
  "watchers": [],
  "custom_css": "text",
  "screen_category_id": "text",
  "id": "text",
  "created_at": "2025-01-02T16:36:41.753Z",
  "updated_at": "2025-01-02T16:36:41.753Z"
}

Delete a Task Assignment

Remove an assignment

DELETE/api/1.0/task_assignments/{task_assignment}

Path parameters

task_assignment*integer

ID of task assignment to delete

Body

process_idinteger (id)

Represents a business process task assignment definition.

process_task_idstring (id)

assignment_idinteger (id)

assignment_typeenum

ProcessMaker\Models\UserProcessMaker\Models\Group

Response

success

Request

const response = await fetch('/api/1.0/task_assignments/{task_assignment}', {
    method: 'DELETE',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Update script executor

Update and rebuild the script executor

PUT/api/1.0/script-executors/{script_executor}

Path parameters

script_executor*string

ID of script executor to return

Body

titlestring

Represents an Eloquent model of a Script Executor

descriptionstring

languagestring

configstring

Response

success

Body

statusstring

Request

const response = await fetch('/api/1.0/script-executors/{script_executor}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "status": "text"
}

Returns all available languages

Get a list of available languages.

GET/api/1.0/script-executors/available-languages

Query parameters

filterstring

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

order_bystring

Field to order results by

order_directionenum

ascdesc

per_pageinteger

Response

list of available languages

Body

dataarray of availableLanguages (object)

textstring

valuestring

initDockerFilestring

metaobject

Request

const response = await fetch('/api/1.0/script-executors/available-languages', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "data": [
    {
      "text": "text",
      "value": "text",
      "initDockerFile": "text"
    }
  ]
}

Get single group member by ID

Display the specified resource.

GET/api/1.0/group_members/{group_member_id}

Path parameters

group_member_id*string

ID of group members to return

Response

Successfully found the group members

Body

group_idstring (id)

member_idstring (id)

member_typestring

idstring (id)

created_atstring (date-time)

updated_atstring (date-time)

Request

const response = await fetch('/api/1.0/group_members/{group_member_id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "group_id": "text",
  "member_id": "text",
  "member_type": "text",
  "id": "text",
  "created_at": "2025-01-02T16:36:41.753Z",
  "updated_at": "2025-01-02T16:36:41.753Z"
}

Update a process Category

Updates the current element

PUT/api/1.0/process_categories/{process_category_id}

Path parameters

process_category_id*integer

ID of process category to return

Body

namestring

Represents a business process category definition.

statusenum

ACTIVEINACTIVE

Response

success

Body

namestring

Represents a business process category definition.

statusenum

ACTIVEINACTIVE

idstring (id)

created_atstring (date-time)

updated_atstring (date-time)

Request

const response = await fetch('/api/1.0/process_categories/{process_category_id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "name": "text",
  "status": "ACTIVE",
  "id": "text",
  "created_at": "2025-01-02T16:36:41.753Z",
  "updated_at": "2025-01-02T16:36:41.753Z"
}

Create a new environment variable

Creates a new global Environment Variable in the system

POST/api/1.0/environment_variables

Body

namestring

descriptionstring

valuestring

Response

success

Body

namestring

descriptionstring

valuestring

idinteger (id)

created_atstring (date-time)

updated_atstring (date-time)

Request

const response = await fetch('/api/1.0/environment_variables', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "name": "text",
  "description": "text",
  "value": "text",
  "id": 0,
  "created_at": "2025-01-02T16:36:41.753Z",
  "updated_at": "2025-01-02T16:36:41.753Z"
}

Update a screen Category

Updates the current element

PUT/api/1.0/screen_categories/{screen_category_id}

Path parameters

screen_category_id*string

ID of screen category to return

Body

namestring

Represents a business screen category definition.

statusenum

ACTIVEINACTIVE

Response

success

Body

namestring

Represents a business screen category definition.

statusenum

ACTIVEINACTIVE

idstring (id)

created_atstring (date-time)

updated_atstring (date-time)

Request

const response = await fetch('/api/1.0/screen_categories/{screen_category_id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "name": "text",
  "status": "ACTIVE",
  "id": "text",
  "created_at": "2025-01-02T16:36:41.753Z",
  "updated_at": "2025-01-02T16:36:41.753Z"
}

Update a script Category

Updates the current element

PUT/api/1.0/script_categories/{script_category_id}

Path parameters

script_category_id*string

ID of script category to return

Body

namestring

Represents a business script category definition.

statusenum

ACTIVEINACTIVE

Response

success

Body

namestring

Represents a business script category definition.

statusenum

ACTIVEINACTIVE

idstring (id)

created_atstring (date-time)

updated_atstring (date-time)

Request

const response = await fetch('/api/1.0/script_categories/{script_category_id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "name": "text",
  "status": "ACTIVE",
  "id": "text",
  "created_at": "2025-01-02T16:36:41.753Z",
  "updated_at": "2025-01-02T16:36:41.753Z"
}

Restore an inactive process

Reverses the soft delete of the element.

PUT/api/1.0/processes/{processId}/restore

Path parameters

processId*integer

ID of process to return

Response

success

Body

process_category_idinteger (id)

Represents a business process definition.

namestring

descriptionstring

statusenum

ACTIVEINACTIVEARCHIVED

pause_timer_startinteger

cancel_screen_idinteger

has_timer_start_eventsboolean

request_detail_screen_idinteger (id)

is_validinteger

package_keystring

start_eventsarray of ProcessStartEvents (object)

eventDefinitionsobject

parallelMultipleboolean

outgoingobject

incomingobject

idstring

namestring

warningsstring

self_service_tasksobject

signal_eventsarray of object

categoryobject

manager_idinteger (id)

user_idinteger (id)

idstring (id)

deleted_atstring (date-time)

created_atstring (date-time)

updated_atstring (date-time)

notificationsobject

task_notificationsobject

Request

const response = await fetch('/api/1.0/processes/{processId}/restore', {
    method: 'PUT',
    headers: {},
});
const data = await response.json();

Response

{
  "process_category_id": 0,
  "name": "text",
  "description": "text",
  "status": "ACTIVE",
  "pause_timer_start": 0,
  "cancel_screen_id": 0,
  "has_timer_start_events": false,
  "request_detail_screen_id": 0,
  "is_valid": 0,
  "package_key": "text",
  "start_events": [
    {
      "parallelMultiple": false,
      "id": "text",
      "name": "text"
    }
  ],
  "warnings": "text",
  "signal_events": [],
  "manager_id": 0,
  "user_id": 0,
  "id": "text",
  "deleted_at": "2025-01-02T16:36:41.753Z",
  "created_at": "2025-01-02T16:36:41.753Z",
  "updated_at": "2025-01-02T16:36:41.753Z"
}

Update a group

Update a user

PUT/api/1.0/groups/{group_id}

Path parameters

group_id*integer

ID of group to return

Body

namestring

Represents a group definition.

descriptionstring

manager_idinteger (id)

statusenum

ACTIVEINACTIVE

Response

success

Request

const response = await fetch('/api/1.0/groups/{group_id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "error": "text"
}

Update an environment variable

PUT/api/1.0/environment_variables/{environment_variable_id}

Path parameters

environment_variable_id*integer

ID of environment variables to update

Body

namestring

descriptionstring

valuestring

Response

success

Body

namestring

descriptionstring

valuestring

idinteger (id)

created_atstring (date-time)

updated_atstring (date-time)

Request

const response = await fetch('/api/1.0/environment_variables/{environment_variable_id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "name": "text",
  "description": "text",
  "value": "text",
  "id": 0,
  "created_at": "2025-01-02T16:36:41.753Z",
  "updated_at": "2025-01-02T16:36:41.753Z"
}

Save a new process Category

Store a newly created Process Category in storage

POST/api/1.0/process_categories

Body

namestring

Represents a business process category definition.

statusenum

ACTIVEINACTIVE

Response

success

Body

namestring

Represents a business process category definition.

statusenum

ACTIVEINACTIVE

idstring (id)

created_atstring (date-time)

updated_atstring (date-time)

Request

const response = await fetch('/api/1.0/process_categories', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "name": "text",
  "status": "ACTIVE",
  "id": "text",
  "created_at": "2025-01-02T16:36:41.753Z",
  "updated_at": "2025-01-02T16:36:41.753Z"
}

Save a new Screen Category

Store a newly created Screen Category in storage

POST/api/1.0/screen_categories

Body

namestring

Represents a business screen category definition.

statusenum

ACTIVEINACTIVE

Response

success

Body

namestring

Represents a business screen category definition.

statusenum

ACTIVEINACTIVE

idstring (id)

created_atstring (date-time)

updated_atstring (date-time)

Request

const response = await fetch('/api/1.0/screen_categories', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "name": "text",
  "status": "ACTIVE",
  "id": "text",
  "created_at": "2025-01-02T16:36:41.753Z",
  "updated_at": "2025-01-02T16:36:41.753Z"
}

Save a new Script Category

Store a newly created Script Category in storage

POST/api/1.0/script_categories

Body

namestring

Represents a business script category definition.

statusenum

ACTIVEINACTIVE

Response

success

Body

namestring

Represents a business script category definition.

statusenum

ACTIVEINACTIVE

idstring (id)

created_atstring (date-time)

updated_atstring (date-time)

Request

const response = await fetch('/api/1.0/script_categories', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "name": "text",
  "status": "ACTIVE",
  "id": "text",
  "created_at": "2025-01-02T16:36:41.753Z",
  "updated_at": "2025-01-02T16:36:41.753Z"
}

Returns all processes categories that the user has access to

Display a listing of the Process Categories.

GET/api/1.0/process_categories

Query parameters

filterstring

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

order_bystring

Field to order results by

order_directionenum

ascdesc

per_pageinteger

Response

list of processes categories

Body

dataarray of ProcessCategory (all of)

namestring

Represents a business process category definition.

statusenum

ACTIVEINACTIVE

idstring (id)

created_atstring (date-time)

updated_atstring (date-time)

metaobject

Request

const response = await fetch('/api/1.0/process_categories', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "data": [
    {
      "name": "text",
      "status": "ACTIVE",
      "id": "text",
      "created_at": "2025-01-02T16:36:41.753Z",
      "updated_at": "2025-01-02T16:36:41.753Z"
    }
  ]
}

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

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

GET/api/1.0/environment_variables

Query parameters

filterstring

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

order_bystring

Field to order results by

order_directionenum

ascdesc

per_pageinteger

includestring

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

Response

list of environmentVariables

Body

dataarray of EnvironmentVariable (all of)

namestring

descriptionstring

valuestring

idinteger (id)

created_atstring (date-time)

updated_atstring (date-time)

metaobject

Request

const response = await fetch('/api/1.0/environment_variables', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "data": [
    {
      "name": "text",
      "description": "text",
      "value": "text",
      "id": 0,
      "created_at": "2025-01-02T16:36:41.753Z",
      "updated_at": "2025-01-02T16:36:41.753Z"
    }
  ]
}

Returns all screens categories that the user has access to

Display a listing of the Screen Categories.

GET/api/1.0/screen_categories

Query parameters

filterstring

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

order_bystring

Field to order results by

order_directionenum

ascdesc

per_pageinteger

Response

list of screens categories

Body

dataarray of ScreenCategory (all of)

namestring

Represents a business screen category definition.

statusenum

ACTIVEINACTIVE

idstring (id)

created_atstring (date-time)

updated_atstring (date-time)

metaobject

Request

const response = await fetch('/api/1.0/screen_categories', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "data": [
    {
      "name": "text",
      "status": "ACTIVE",
      "id": "text",
      "created_at": "2025-01-02T16:36:41.753Z",
      "updated_at": "2025-01-02T16:36:41.753Z"
    }
  ]
}

Returns all screens that the user has access to

Get a list of Screens.

GET/api/1.0/screens

Query parameters

filterstring

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

order_bystring

Field to order results by

order_directionenum

ascdesc

per_pageinteger

includestring

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

excludestring

Comma separated list of fields to exclude from the response

Response

list of screens

Body

dataarray of screens (all of)

titlestring

Class Screen

typestring

descriptionstring

configarray of object

computedarray of object

watchersarray of object

custom_cssstring

screen_category_idstring

idstring (id)

created_atstring (date-time)

updated_atstring (date-time)

metaobject

Request

const response = await fetch('/api/1.0/screens', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "data": [
    {
      "title": "text",
      "type": "text",
      "description": "text",
      "config": [],
      "computed": [],
      "watchers": [],
      "custom_css": "text",
      "screen_category_id": "text",
      "id": "text",
      "created_at": "2025-01-02T16:36:41.753Z",
      "updated_at": "2025-01-02T16:36:41.753Z"
    }
  ]
}

Save a new screens

Create a new Screen.

POST/api/1.0/screens

Body

titlestring

Class Screen

typestring

descriptionstring

configarray of object

computedarray of object

watchersarray of object

custom_cssstring

screen_category_idstring

Response

success

Body

titlestring

Class Screen

typestring

descriptionstring

configarray of object

computedarray of object

watchersarray of object

custom_cssstring

screen_category_idstring

idstring (id)

created_atstring (date-time)

updated_atstring (date-time)

Request

const response = await fetch('/api/1.0/screens', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "title": "text",
  "type": "text",
  "description": "text",
  "config": [],
  "computed": [],
  "watchers": [],
  "custom_css": "text",
  "screen_category_id": "text",
  "id": "text",
  "created_at": "2025-01-02T16:36:41.753Z",
  "updated_at": "2025-01-02T16:36:41.753Z"
}

Returns all task assignments

Display a listing of the resource.

GET/api/1.0/task_assignments

Query parameters

filterstring

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

order_bystring

Field to order results by

order_directionenum

ascdesc

per_pageinteger

Response

list of task assignments

Body

dataarray of taskAssignments (object)

process_idinteger (id)

Represents a business process task assignment definition.

process_task_idstring (id)

assignment_idinteger (id)

assignment_typeenum

ProcessMaker\Models\UserProcessMaker\Models\Group

idinteger (id)

created_atstring (date-time)

updated_atstring (date-time)

metaobject

Request

const response = await fetch('/api/1.0/task_assignments', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "data": [
    {
      "process_id": 0,
      "process_task_id": "text",
      "assignment_id": 0,
      "assignment_type": "ProcessMaker\\Models\\User",
      "id": 0,
      "created_at": "2025-01-02T16:36:41.753Z",
      "updated_at": "2025-01-02T16:36:41.753Z"
    }
  ]
}

Returns all scripts categories that the user has access to

Display a listing of the Script Categories.

GET/api/1.0/script_categories

Query parameters

filterstring

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

order_bystring

Field to order results by

order_directionenum

ascdesc

per_pageinteger

Response

list of scripts categories

Body

dataarray of ScriptCategory (all of)

namestring

Represents a business script category definition.

statusenum

ACTIVEINACTIVE

idstring (id)

created_atstring (date-time)

updated_atstring (date-time)

metaobject

Request

const response = await fetch('/api/1.0/script_categories', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "data": [
    {
      "name": "text",
      "status": "ACTIVE",
      "id": "text",
      "created_at": "2025-01-02T16:36:41.753Z",
      "updated_at": "2025-01-02T16:36:41.753Z"
    }
  ]
}

Returns all scripts that the user has access to

Get a list of scripts in a process.

GET/api/1.0/scripts

Query parameters

filterstring

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

order_bystring

Field to order results by

order_directionenum

ascdesc

per_pageinteger

includestring

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

Response

list of scripts

Body

dataarray of scripts (all of)

titlestring

Represents an Eloquent model of a Script

descriptionstring

languagestring

codestring

timeoutinteger

run_as_user_idinteger

keystring

script_category_idinteger

idinteger (id)

created_atstring (date-time)

updated_atstring (date-time)

metaobject

Request

const response = await fetch('/api/1.0/scripts', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "data": [
    {
      "title": "text",
      "description": "text",
      "language": "text",
      "code": "text",
      "timeout": 0,
      "run_as_user_id": 0,
      "key": "text",
      "script_category_id": 0,
      "id": 0,
      "created_at": "2025-01-02T16:36:41.753Z",
      "updated_at": "2025-01-02T16:36:41.753Z"
    }
  ]
}

Returns all script executors that the user has access to

Get a list of script executors.

GET/api/1.0/script-executors

Query parameters

filterstring

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

order_bystring

Field to order results by

order_directionenum

ascdesc

per_pageinteger

Response

list of script executors

Body

dataarray of scriptExecutors (all of)

titlestring

Represents an Eloquent model of a Script Executor

descriptionstring

languagestring

configstring

idinteger (id)

created_atstring (date-time)

updated_atstring (date-time)

metaobject

Request

const response = await fetch('/api/1.0/script-executors', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "data": [
    {
      "title": "text",
      "description": "text",
      "language": "text",
      "config": "text",
      "id": 0,
      "created_at": "2025-01-02T16:36:41.753Z",
      "updated_at": "2025-01-02T16:36:41.753Z"
    }
  ]
}

Get single process by ID

Display the specified resource.

GET/api/1.0/processes/{processId}

Path parameters

processId*integer

ID of process to return

Query parameters

includestring

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

Response

Successfully found the process

Body

process_category_idinteger (id)

Represents a business process definition.

namestring

descriptionstring

statusenum

ACTIVEINACTIVEARCHIVED

pause_timer_startinteger

cancel_screen_idinteger

has_timer_start_eventsboolean

request_detail_screen_idinteger (id)

is_validinteger

package_keystring

start_eventsarray of ProcessStartEvents (object)

eventDefinitionsobject

parallelMultipleboolean

outgoingobject

incomingobject

idstring

namestring

warningsstring

self_service_tasksobject

signal_eventsarray of object

categoryobject

manager_idinteger (id)

user_idinteger (id)

idstring (id)

deleted_atstring (date-time)

created_atstring (date-time)

updated_atstring (date-time)

notificationsobject

task_notificationsobject

Request

const response = await fetch('/api/1.0/processes/{processId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "process_category_id": 0,
  "name": "text",
  "description": "text",
  "status": "ACTIVE",
  "pause_timer_start": 0,
  "cancel_screen_id": 0,
  "has_timer_start_events": false,
  "request_detail_screen_id": 0,
  "is_valid": 0,
  "package_key": "text",
  "start_events": [
    {
      "parallelMultiple": false,
      "id": "text",
      "name": "text"
    }
  ],
  "warnings": "text",
  "signal_events": [],
  "manager_id": 0,
  "user_id": 0,
  "id": "text",
  "deleted_at": "2025-01-02T16:36:41.753Z",
  "created_at": "2025-01-02T16:36:41.753Z",
  "updated_at": "2025-01-02T16:36:41.753Z"
}

Returns all notifications that the user has access to

Display a listing of the resource.

GET/api/1.0/notifications

Query parameters

statusstring

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

filterstring

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

order_bystring

Field to order results by

order_directionenum

ascdesc

per_pageinteger

includestring

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

Response

list of notifications

Body

dataarray of Notification (all of)

typestring

Represents a notification definition.

notifiable_typestring

notifiable_idinteger

datastring

namestring

messagestring

processNamestring

userNamestring

request_idstring

urlstring

idstring

read_atstring (date-time)

created_atstring (date-time)

updated_atstring (date-time)

metaany

Request

const response = await fetch('/api/1.0/notifications', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "data": [
    {
      "type": "text",
      "notifiable_type": "text",
      "notifiable_id": 0,
      "data": "text",
      "name": "text",
      "message": "text",
      "processName": "text",
      "userName": "text",
      "request_id": "text",
      "url": "text",
      "id": "text",
      "read_at": "2025-01-02T16:36:41.753Z",
      "created_at": "2025-01-02T16:36:41.753Z",
      "updated_at": "2025-01-02T16:36:41.753Z"
    }
  ]
}

Get single script by ID

Get a single script in a process.

GET/api/1.0/scripts/{script_id}

Path parameters

script_id*string

ID of script to return

Response

Successfully found the script

Body

titlestring

Represents an Eloquent model of a Script

descriptionstring

languagestring

codestring

timeoutinteger

run_as_user_idinteger

keystring

script_category_idinteger

idinteger (id)

created_atstring (date-time)

updated_atstring (date-time)

Request

const response = await fetch('/api/1.0/scripts/{script_id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "title": "text",
  "description": "text",
  "language": "text",
  "code": "text",
  "timeout": 0,
  "run_as_user_id": 0,
  "key": "text",
  "script_category_id": 0,
  "id": 0,
  "created_at": "2025-01-02T16:36:41.753Z",
  "updated_at": "2025-01-02T16:36:41.753Z"
}

duplicate a script

duplicate a Script.

PUT/api/1.0/scripts/{scripts_id}/duplicate

Path parameters

scripts_id*string

ID of script to return

Body

titlestring

Represents an Eloquent model of a Script

descriptionstring

languagestring

codestring

timeoutinteger

run_as_user_idinteger

keystring

script_category_idinteger

Response

success

Body

titlestring

Represents an Eloquent model of a Script

descriptionstring

languagestring

codestring

timeoutinteger

run_as_user_idinteger

keystring

script_category_idinteger

idinteger (id)

created_atstring (date-time)

updated_atstring (date-time)

Request

const response = await fetch('/api/1.0/scripts/{scripts_id}/duplicate', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "title": "text",
  "description": "text",
  "language": "text",
  "code": "text",
  "timeout": 0,
  "run_as_user_id": 0,
  "key": "text",
  "script_category_id": 0,
  "id": 0,
  "created_at": "2025-01-02T16:36:41.753Z",
  "updated_at": "2025-01-02T16:36:41.753Z"
}

Get single group by ID

Display the specified resource.

GET/api/1.0/groups/{group_id}

Path parameters

group_id*integer

ID of group to return

Response

Successfully found the group

Body

namestring

Represents a group definition.

descriptionstring

manager_idinteger (id)

statusenum

ACTIVEINACTIVE

created_atstring (date-time)

updated_atstring (date-time)

idstring (id)

Request

const response = await fetch('/api/1.0/groups/{group_id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "name": "text",
  "description": "text",
  "manager_id": 0,
  "status": "ACTIVE",
  "created_at": "2025-01-02T16:36:41.753Z",
  "updated_at": "2025-01-02T16:36:41.753Z",
  "id": "text"
}

Create new token for a specific user

Create a new personal access token for the user.

POST/api/1.0/users/{user_id}/tokens

Path parameters

user_id*integer

User id

Body

namestring

Response

New token instance

Body

idstring

user_idinteger

client_idinteger

namestring

scopesobject

revokedboolean

clientTokenClient (object)

idinteger

user_idinteger

namestring

providerstring

redirectstring

personal_access_clientboolean

password_clientboolean

revokedboolean

created_atstring (date-time)

updated_atstring (date-time)

created_atstring (date-time)

updated_atstring (date-time)

expires_atstring (date-time)

Request

const response = await fetch('/api/1.0/users/{user_id}/tokens', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "id": "text",
  "user_id": 0,
  "client_id": 0,
  "name": "text",
  "revoked": false,
  "client": {
    "id": 0,
    "user_id": 0,
    "name": "text",
    "provider": "text",
    "redirect": "text",
    "personal_access_client": false,
    "password_client": false,
    "revoked": false,
    "created_at": "2025-01-02T16:36:41.753Z",
    "updated_at": "2025-01-02T16:36:41.753Z"
  },
  "created_at": "2025-01-02T16:36:41.753Z",
  "updated_at": "2025-01-02T16:36:41.753Z",
  "expires_at": "2025-01-02T16:36:41.753Z"
}

Save a new group member

Store a newly created resource in storage.

POST/api/1.0/group_members

Body

group_idstring (id)

Represents a group Members definition.

member_idstring (id)

member_typestring

descriptionstring

Response

success

Body

group_idstring (id)

Represents a group Members definition.

member_idstring (id)

member_typestring

descriptionstring

idstring (id)

groupobject

memberobject

created_atstring (date-time)

updated_atstring (date-time)

Request

const response = await fetch('/api/1.0/group_members', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "group_id": "text",
  "member_id": "text",
  "member_type": "text",
  "description": "text",
  "id": "text",
  "created_at": "2025-01-02T16:36:41.753Z",
  "updated_at": "2025-01-02T16:36:41.753Z"
}

Update a process request

Update a request

PUT/api/1.0/requests/{process_request_id}

Path parameters

process_request_id*integer

ID of process request to return

Body

user_idstring (id)

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

callable_idstring (id)

dataobject

statusenum

ACTIVECOMPLETEDERRORCANCELED

namestring

process_idinteger

processobject

Response

success

Request

const response = await fetch('/api/1.0/requests/{process_request_id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "error": "text"
}

Create or update a new setting

Create a new Settings css-override

POST/api/1.0/customize-ui

Body

variablesstring

sansSerifFontstring

Response

success

Body

keystring

Class Settings

configarray of object

namestring

helperstring

groupstring

formatstring

hiddenboolean

readonlyboolean

variablesstring

sansSerifFontstring

idstring (id)

created_atstring (date-time)

updated_atstring (date-time)

Request

const response = await fetch('/api/1.0/customize-ui', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "key": "text",
  "config": [],
  "name": "text",
  "helper": "text",
  "group": "text",
  "format": "text",
  "hidden": false,
  "readonly": false,
  "variables": "text",
  "sansSerifFont": "text",
  "id": "text",
  "created_at": "2025-01-02T16:36:41.753Z",
  "updated_at": "2025-01-02T16:36:41.753Z"
}

Get single notification by ID

Display the specified resource.

GET/api/1.0/notifications/{notification_id}

Path parameters

notification_id*string

ID of notification to return

Response

Successfully found the notification

Body

typestring

Represents a notification definition.

notifiable_typestring

notifiable_idinteger

datastring

namestring

messagestring

processNamestring

userNamestring

request_idstring

urlstring

idstring

read_atstring (date-time)

created_atstring (date-time)

updated_atstring (date-time)

Request

const response = await fetch('/api/1.0/notifications/{notification_id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "type": "text",
  "notifiable_type": "text",
  "notifiable_id": 0,
  "data": "text",
  "name": "text",
  "message": "text",
  "processName": "text",
  "userName": "text",
  "request_id": "text",
  "url": "text",
  "id": "text",
  "read_at": "2025-01-02T16:36:41.753Z",
  "created_at": "2025-01-02T16:36:41.753Z",
  "updated_at": "2025-01-02T16:36:41.753Z"
}

Get single screens by ID

Get a single Screen.

GET/api/1.0/screens/{screens_id}

Path parameters

screens_id*string

ID of screens to return

Response

Successfully found the screen

Body

titlestring

Class Screen

typestring

descriptionstring

configarray of object

computedarray of object

watchersarray of object

custom_cssstring

screen_category_idstring

idstring (id)

created_atstring (date-time)

updated_atstring (date-time)

Request

const response = await fetch('/api/1.0/screens/{screens_id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "title": "text",
  "type": "text",
  "description": "text",
  "config": [],
  "computed": [],
  "watchers": [],
  "custom_css": "text",
  "screen_category_id": "text",
  "id": "text",
  "created_at": "2025-01-02T16:36:41.753Z",
  "updated_at": "2025-01-02T16:36:41.753Z"
}

Save a new script

Create a new script in a process.

POST/api/1.0/scripts

Body

titlestring

Represents an Eloquent model of a Script

descriptionstring

languagestring

codestring

timeoutinteger

run_as_user_idinteger

keystring

script_category_idinteger

Response

success

Body

titlestring

Represents an Eloquent model of a Script

descriptionstring

languagestring

codestring

timeoutinteger

run_as_user_idinteger

keystring

script_category_idinteger

idinteger (id)

created_atstring (date-time)

updated_atstring (date-time)

Request

const response = await fetch('/api/1.0/scripts', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "title": "text",
  "description": "text",
  "language": "text",
  "code": "text",
  "timeout": 0,
  "run_as_user_id": 0,
  "key": "text",
  "script_category_id": 0,
  "id": 0,
  "created_at": "2025-01-02T16:36:41.753Z",
  "updated_at": "2025-01-02T16:36:41.753Z"
}

duplicate a screen

duplicate a Screen.

PUT/api/1.0/screens/{screens_id}/duplicate

Path parameters

screens_id*string

ID of screen to return

Body

titlestring

Class Screen

typestring

descriptionstring

configarray of object

computedarray of object

watchersarray of object

custom_cssstring

screen_category_idstring

Response

success

Body

titlestring

Class Screen

typestring

descriptionstring

configarray of object

computedarray of object

watchersarray of object

custom_cssstring

screen_category_idstring

idstring (id)

created_atstring (date-time)

updated_atstring (date-time)

Request

const response = await fetch('/api/1.0/screens/{screens_id}/duplicate', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "title": "text",
  "type": "text",
  "description": "text",
  "config": [],
  "computed": [],
  "watchers": [],
  "custom_css": "text",
  "screen_category_id": "text",
  "id": "text",
  "created_at": "2025-01-02T16:36:41.753Z",
  "updated_at": "2025-01-02T16:36:41.753Z"
}

Start a new process

Trigger an start event within a process.

POST/api/1.0/process_events/{process_id}

Path parameters

process_id*integer

ID of process to return

Query parameters

event*string

Node ID of the start event

Body

data that will be stored as part of the created request

object

Response

success

Body

user_idstring (id)

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

callable_idstring (id)

dataobject

statusenum

ACTIVECOMPLETEDERRORCANCELED

namestring

process_idinteger

processobject

idstring (id)

process_idstring (id)

process_collaboration_idstring (id)

participant_idstring (id)

process_category_idstring (id)

created_atstring (date-time)

updated_atstring (date-time)

userany

participantsarray of users (all of)

emailstring (email)

The attributes that are mass assignable.

firstnamestring

lastnamestring

usernamestring

passwordstring

addressstring

citystring

statestring

postalstring

countrystring

phonestring

faxstring

cellstring

titlestring

timezonestring

datetime_formatstring

languagestring

is_administratorboolean

expires_atstring

loggedin_atstring

remember_tokenstring

statusenum

ACTIVEINACTIVESCHEDULEDOUT_OF_OFFICE

fullnamestring

avatarstring

mediaarray of media (object)

idinteger (id)

Represents media files stored in the database

model_idinteger (id)

model_typestring (id)

collection_namestring

namestring

file_namestring

mime_typestring

diskstring

sizeinteger

manipulationsobject

custom_propertiesobject

responsive_imagesobject

order_columninteger

created_atstring (date-time)

updated_atstring (date-time)

birthdatestring (date)

delegation_user_idstring (id)

manager_idstring (id)

metaobject

Other propertiesany

force_change_passwordboolean

idinteger

created_atstring (date-time)

updated_atstring (date-time)

deleted_atstring (date-time)

Request

const response = await fetch('/api/1.0/process_events/{process_id}?event=text', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
});
const data = await response.json();

Response

{
  "user_id": "text",
  "callable_id": "text",
  "status": "ACTIVE",
  "name": "text",
  "process_id": "text",
  "id": "text",
  "process_collaboration_id": "text",
  "participant_id": "text",
  "process_category_id": "text",
  "created_at": "2025-01-02T16:36:41.753Z",
  "updated_at": "2025-01-02T16:36:41.753Z",
  "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": false,
      "expires_at": "text",
      "loggedin_at": "text",
      "remember_token": "text",
      "status": "ACTIVE",
      "fullname": "text",
      "avatar": "text",
      "media": [
        {
          "id": 0,
          "model_id": 0,
          "model_type": "text",
          "collection_name": "text",
          "name": "text",
          "file_name": "text",
          "mime_type": "text",
          "disk": "text",
          "size": 0,
          "order_column": 0,
          "created_at": "2025-01-02T16:36:41.753Z",
          "updated_at": "2025-01-02T16:36:41.753Z"
        }
      ],
      "birthdate": "2025-01-02",
      "delegation_user_id": "text",
      "manager_id": "text",
      "force_change_password": false,
      "id": 0,
      "created_at": "2025-01-02T16:36:41.753Z",
      "updated_at": "2025-01-02T16:36:41.753Z",
      "deleted_at": "2025-01-02T16:36:41.753Z"
    }
  ]
}

Get single process request by ID

Display the specified resource.

GET/api/1.0/requests/{process_request_id}

Path parameters

process_request_id*integer

ID of process request to return

Query parameters

includestring

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

Response

Successfully found the process

Body

user_idstring (id)

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

callable_idstring (id)

dataobject

statusenum

ACTIVECOMPLETEDERRORCANCELED

namestring

process_idinteger

processobject

idstring (id)

process_idstring (id)

process_collaboration_idstring (id)

participant_idstring (id)

process_category_idstring (id)

created_atstring (date-time)

updated_atstring (date-time)

userany

participantsarray of users (all of)

emailstring (email)

The attributes that are mass assignable.

firstnamestring

lastnamestring

usernamestring

passwordstring

addressstring

citystring

statestring

postalstring

countrystring

phonestring

faxstring

cellstring

titlestring

timezonestring

datetime_formatstring

languagestring

is_administratorboolean

expires_atstring

loggedin_atstring

remember_tokenstring

statusenum

ACTIVEINACTIVESCHEDULEDOUT_OF_OFFICE

fullnamestring

avatarstring

mediaarray of media (object)

idinteger (id)

Represents media files stored in the database

model_idinteger (id)

model_typestring (id)

collection_namestring

namestring

file_namestring

mime_typestring

diskstring

sizeinteger

manipulationsobject

custom_propertiesobject

responsive_imagesobject

order_columninteger

created_atstring (date-time)

updated_atstring (date-time)

birthdatestring (date)

delegation_user_idstring (id)

manager_idstring (id)

metaobject

Other propertiesany

force_change_passwordboolean

idinteger

created_atstring (date-time)

updated_atstring (date-time)

deleted_atstring (date-time)

Request

const response = await fetch('/api/1.0/requests/{process_request_id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "user_id": "text",
  "callable_id": "text",
  "status": "ACTIVE",
  "name": "text",
  "process_id": "text",
  "id": "text",
  "process_collaboration_id": "text",
  "participant_id": "text",
  "process_category_id": "text",
  "created_at": "2025-01-02T16:36:41.753Z",
  "updated_at": "2025-01-02T16:36:41.753Z",
  "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": false,
      "expires_at": "text",
      "loggedin_at": "text",
      "remember_token": "text",
      "status": "ACTIVE",
      "fullname": "text",
      "avatar": "text",
      "media": [
        {
          "id": 0,
          "model_id": 0,
          "model_type": "text",
          "collection_name": "text",
          "name": "text",
          "file_name": "text",
          "mime_type": "text",
          "disk": "text",
          "size": 0,
          "order_column": 0,
          "created_at": "2025-01-02T16:36:41.753Z",
          "updated_at": "2025-01-02T16:36:41.753Z"
        }
      ],
      "birthdate": "2025-01-02",
      "delegation_user_id": "text",
      "manager_id": "text",
      "force_change_password": false,
      "id": 0,
      "created_at": "2025-01-02T16:36:41.753Z",
      "updated_at": "2025-01-02T16:36:41.753Z",
      "deleted_at": "2025-01-02T16:36:41.753Z"
    }
  ]
}

Save a new notifications

Store a newly created resource in storage.

POST/api/1.0/notifications

Body

typestring

Represents a notification definition.

notifiable_typestring

notifiable_idinteger

datastring

namestring

messagestring

processNamestring

userNamestring

request_idstring

urlstring

Response

success

Body

typestring

Represents a notification definition.

notifiable_typestring

notifiable_idinteger

datastring

namestring

messagestring

processNamestring

userNamestring

request_idstring

urlstring

idstring

read_atstring (date-time)

created_atstring (date-time)

updated_atstring (date-time)

Request

const response = await fetch('/api/1.0/notifications', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "type": "text",
  "notifiable_type": "text",
  "notifiable_id": 0,
  "data": "text",
  "name": "text",
  "message": "text",
  "processName": "text",
  "userName": "text",
  "request_id": "text",
  "url": "text",
  "id": "text",
  "read_at": "2025-01-02T16:36:41.753Z",
  "created_at": "2025-01-02T16:36:41.753Z",
  "updated_at": "2025-01-02T16:36:41.753Z"
}

Delete a process request

Delete a request

DELETE/api/1.0/requests/{process_request_id}

Path parameters

process_request_id*integer

ID of process request to return

Response

success

Body

user_idstring (id)

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

callable_idstring (id)

dataobject

statusenum

ACTIVECOMPLETEDERRORCANCELED

namestring

process_idinteger

processobject

idstring (id)

process_idstring (id)

process_collaboration_idstring (id)

participant_idstring (id)

process_category_idstring (id)

created_atstring (date-time)

updated_atstring (date-time)

userany

participantsarray of users (all of)

emailstring (email)

The attributes that are mass assignable.

firstnamestring

lastnamestring

usernamestring

passwordstring

addressstring

citystring

statestring

postalstring

countrystring

phonestring

faxstring

cellstring

titlestring

timezonestring

datetime_formatstring

languagestring

is_administratorboolean

expires_atstring

loggedin_atstring

remember_tokenstring

statusenum

ACTIVEINACTIVESCHEDULEDOUT_OF_OFFICE

fullnamestring

avatarstring

mediaarray of media (object)

idinteger (id)

Represents media files stored in the database

model_idinteger (id)

model_typestring (id)

collection_namestring

namestring

file_namestring

mime_typestring

diskstring

sizeinteger

manipulationsobject

custom_propertiesobject

responsive_imagesobject

order_columninteger

created_atstring (date-time)

updated_atstring (date-time)

birthdatestring (date)

delegation_user_idstring (id)

manager_idstring (id)

metaobject

Other propertiesany

force_change_passwordboolean

idinteger

created_atstring (date-time)

updated_atstring (date-time)

deleted_atstring (date-time)

Request

const response = await fetch('/api/1.0/requests/{process_request_id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

{
  "user_id": "text",
  "callable_id": "text",
  "status": "ACTIVE",
  "name": "text",
  "process_id": "text",
  "id": "text",
  "process_collaboration_id": "text",
  "participant_id": "text",
  "process_category_id": "text",
  "created_at": "2025-01-02T16:36:41.753Z",
  "updated_at": "2025-01-02T16:36:41.753Z",
  "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": false,
      "expires_at": "text",
      "loggedin_at": "text",
      "remember_token": "text",
      "status": "ACTIVE",
      "fullname": "text",
      "avatar": "text",
      "media": [
        {
          "id": 0,
          "model_id": 0,
          "model_type": "text",
          "collection_name": "text",
          "name": "text",
          "file_name": "text",
          "mime_type": "text",
          "disk": "text",
          "size": 0,
          "order_column": 0,
          "created_at": "2025-01-02T16:36:41.753Z",
          "updated_at": "2025-01-02T16:36:41.753Z"
        }
      ],
      "birthdate": "2025-01-02",
      "delegation_user_id": "text",
      "manager_id": "text",
      "force_change_password": false,
      "id": 0,
      "created_at": "2025-01-02T16:36:41.753Z",
      "updated_at": "2025-01-02T16:36:41.753Z",
      "deleted_at": "2025-01-02T16:36:41.753Z"
    }
  ]
}

Update a Task Assignment

Update a task assignment

PUT/api/1.0/task_assignments/{task_assignment}

Path parameters

task_assignment*integer

ID of task assignment to update

Body

process_idinteger (id)

Represents a business process task assignment definition.

process_task_idstring (id)

assignment_idinteger (id)

assignment_typeenum

ProcessMaker\Models\UserProcessMaker\Models\Group

Response

success

Request

const response = await fetch('/api/1.0/task_assignments/{task_assignment}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "error": "text"
}

Save a new group

Store a newly created resource in storage.

POST/api/1.0/groups

Body

namestring

Represents a group definition.

descriptionstring

manager_idinteger (id)

statusenum

ACTIVEINACTIVE

Response

success

Body

namestring

Represents a group definition.

descriptionstring

manager_idinteger (id)

statusenum

ACTIVEINACTIVE

created_atstring (date-time)

updated_atstring (date-time)

idstring (id)

Request

const response = await fetch('/api/1.0/groups', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "name": "text",
  "description": "text",
  "manager_id": 0,
  "status": "ACTIVE",
  "created_at": "2025-01-02T16:36:41.753Z",
  "updated_at": "2025-01-02T16:36:41.753Z",
  "id": "text"
}

Get a single task by ID

Display the specified resource.

GET/api/1.0/tasks/{task_id}

Path parameters

task_id*integer

task id

Query parameters

includestring

include

Response

success

Body

user_idstring (id)

ProcessRequestToken is used to store the state of a token of the Nayra engine

statusstring

due_atstring (date-time)

initiated_atstring (date-time)

riskchanges_atstring (date-time)

subprocess_start_event_idstring

dataobject

idstring (id)

process_idstring (id)

process_request_idstring (id)

element_idstring (id)

element_typestring (id)

element_indexstring

element_namestring

created_atstring (date-time)

updated_atstring (date-time)

initiated_atstring (date-time)

advanceStatusstring

due_notifiedinteger

userobject

processobject

process_requestobject

Request

const response = await fetch('/api/1.0/tasks/{task_id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "user_id": "text",
  "status": "text",
  "due_at": "2025-01-02T16:36:41.753Z",
  "initiated_at": "2025-01-02T16:36:41.753Z",
  "riskchanges_at": "2025-01-02T16:36:41.753Z",
  "subprocess_start_event_id": "text",
  "id": "text",
  "process_id": "text",
  "process_request_id": "text",
  "element_id": "text",
  "element_type": "text",
  "element_index": "text",
  "element_name": "text",
  "created_at": "2025-01-02T16:36:41.753Z",
  "updated_at": "2025-01-02T16:36:41.753Z",
  "advanceStatus": "text",
  "due_notified": 0
}

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

Get a single media file.

GET/api/1.0/files/{file_id}

Path parameters

file_id*integer

ID of the file to return

Response

Successfully found the file

Body

idinteger (id)

Represents media files stored in the database

model_idinteger (id)

model_typestring (id)

collection_namestring

namestring

file_namestring

mime_typestring

diskstring

sizeinteger

manipulationsobject

custom_propertiesobject

responsive_imagesobject

order_columninteger

created_atstring (date-time)

updated_atstring (date-time)

Request

const response = await fetch('/api/1.0/files/{file_id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "id": 0,
  "model_id": 0,
  "model_type": "text",
  "collection_name": "text",
  "name": "text",
  "file_name": "text",
  "mime_type": "text",
  "disk": "text",
  "size": 0,
  "order_column": 0,
  "created_at": "2025-01-02T16:36:41.753Z",
  "updated_at": "2025-01-02T16:36:41.753Z"
}

Save a new Task Assignment

Store a newly created task assignment in storage.

POST/api/1.0/task_assignments

Body

process_idinteger (id)

Represents a business process task assignment definition.

process_task_idstring (id)

assignment_idinteger (id)

assignment_typeenum

ProcessMaker\Models\UserProcessMaker\Models\Group

Response

success

Body

process_idinteger (id)

Represents a business process task assignment definition.

process_task_idstring (id)

assignment_idinteger (id)

assignment_typeenum

ProcessMaker\Models\UserProcessMaker\Models\Group

idinteger (id)

created_atstring (date-time)

updated_atstring (date-time)

Request

const response = await fetch('/api/1.0/task_assignments', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "process_id": 0,
  "process_task_id": "text",
  "assignment_id": 0,
  "assignment_type": "ProcessMaker\\Models\\User",
  "id": 0,
  "created_at": "2025-01-02T16:36:41.753Z",
  "updated_at": "2025-01-02T16:36:41.753Z"
}

Get single token by ID

Show a personal access token for the user

GET/api/1.0/users/{user_id}/tokens/{token_id}

Path parameters

user_id*integer

ID of user

token_id*string

ID of token to return

Response

Successfully found the token

Body

idstring

user_idinteger

client_idinteger

namestring

scopesobject

revokedboolean

clientTokenClient (object)

idinteger

user_idinteger

namestring

providerstring

redirectstring

personal_access_clientboolean

password_clientboolean

revokedboolean

created_atstring (date-time)

updated_atstring (date-time)

created_atstring (date-time)

updated_atstring (date-time)

expires_atstring (date-time)

Request

const response = await fetch('/api/1.0/users/{user_id}/tokens/{token_id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "id": "text",
  "user_id": 0,
  "client_id": 0,
  "name": "text",
  "revoked": false,
  "client": {
    "id": 0,
    "user_id": 0,
    "name": "text",
    "provider": "text",
    "redirect": "text",
    "personal_access_client": false,
    "password_client": false,
    "revoked": false,
    "created_at": "2025-01-02T16:36:41.753Z",
    "updated_at": "2025-01-02T16:36:41.753Z"
  },
  "created_at": "2025-01-02T16:36:41.753Z",
  "updated_at": "2025-01-02T16:36:41.753Z",
  "expires_at": "2025-01-02T16:36:41.753Z"
}

Delete a process category

Remove the specified resource from storage.

DELETE/api/1.0/process_categories/{process_category_id}

Path parameters

process_category_id*integer

ID of process category to return

Response

success

Body

process_category_idinteger (id)

Represents a business process definition.

namestring

descriptionstring

statusenum

ACTIVEINACTIVEARCHIVED

pause_timer_startinteger

cancel_screen_idinteger

has_timer_start_eventsboolean

request_detail_screen_idinteger (id)

is_validinteger

package_keystring

start_eventsarray of ProcessStartEvents (object)

eventDefinitionsobject

parallelMultipleboolean

outgoingobject

incomingobject

idstring

namestring

warningsstring

self_service_tasksobject

signal_eventsarray of object

categoryobject

manager_idinteger (id)

user_idinteger (id)

idstring (id)

deleted_atstring (date-time)

created_atstring (date-time)

updated_atstring (date-time)

notificationsobject

task_notificationsobject

Request

const response = await fetch('/api/1.0/process_categories/{process_category_id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

{
  "process_category_id": 0,
  "name": "text",
  "description": "text",
  "status": "ACTIVE",
  "pause_timer_start": 0,
  "cancel_screen_id": 0,
  "has_timer_start_events": false,
  "request_detail_screen_id": 0,
  "is_valid": 0,
  "package_key": "text",
  "start_events": [
    {
      "parallelMultiple": false,
      "id": "text",
      "name": "text"
    }
  ],
  "warnings": "text",
  "signal_events": [],
  "manager_id": 0,
  "user_id": 0,
  "id": "text",
  "deleted_at": "2025-01-02T16:36:41.753Z",
  "created_at": "2025-01-02T16:36:41.753Z",
  "updated_at": "2025-01-02T16:36:41.753Z"
}

Update a process

Updates the current element.

PUT/api/1.0/processes/{processId}

Path parameters

processId*integer

ID of process to return

Body

process_category_idinteger (id)

Represents a business process definition.

namestring

descriptionstring

statusenum

ACTIVEINACTIVEARCHIVED

pause_timer_startinteger

cancel_screen_idinteger

has_timer_start_eventsboolean

request_detail_screen_idinteger (id)

is_validinteger

package_keystring

start_eventsarray of ProcessStartEvents (object)

eventDefinitionsobject

parallelMultipleboolean

outgoingobject

incomingobject

idstring

namestring

warningsstring

self_service_tasksobject

signal_eventsarray of object

categoryobject

manager_idinteger (id)

Response

success

Body

process_category_idinteger (id)

Represents a business process definition.

namestring

descriptionstring

statusenum

ACTIVEINACTIVEARCHIVED

pause_timer_startinteger

cancel_screen_idinteger

has_timer_start_eventsboolean

request_detail_screen_idinteger (id)

is_validinteger

package_keystring

start_eventsarray of ProcessStartEvents (object)

eventDefinitionsobject

parallelMultipleboolean

outgoingobject

incomingobject

idstring

namestring

warningsstring

self_service_tasksobject

signal_eventsarray of object

categoryobject

manager_idinteger (id)

user_idinteger (id)

idstring (id)

deleted_atstring (date-time)

created_atstring (date-time)

updated_atstring (date-time)

notificationsobject

task_notificationsobject

Request

const response = await fetch('/api/1.0/processes/{processId}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "process_category_id": 0,
  "name": "text",
  "description": "text",
  "status": "ACTIVE",
  "pause_timer_start": 0,
  "cancel_screen_id": 0,
  "has_timer_start_events": false,
  "request_detail_screen_id": 0,
  "is_valid": 0,
  "package_key": "text",
  "start_events": [
    {
      "parallelMultiple": false,
      "id": "text",
      "name": "text"
    }
  ],
  "warnings": "text",
  "signal_events": [],
  "manager_id": 0,
  "user_id": 0,
  "id": "text",
  "deleted_at": "2025-01-02T16:36:41.753Z",
  "created_at": "2025-01-02T16:36:41.753Z",
  "updated_at": "2025-01-02T16:36:41.753Z"
}

Validate a import

Validate the specified process before importing.

POST/api/1.0/processes/import/validation

Body

filestring (binary)

file to import

Response

success

Body

process_category_idinteger (id)

Represents a business process definition.

namestring

descriptionstring

statusenum

ACTIVEINACTIVEARCHIVED

pause_timer_startinteger

cancel_screen_idinteger

has_timer_start_eventsboolean

request_detail_screen_idinteger (id)

is_validinteger

package_keystring

start_eventsarray of ProcessStartEvents (object)

eventDefinitionsobject

parallelMultipleboolean

outgoingobject

incomingobject

idstring

namestring

warningsstring

self_service_tasksobject

signal_eventsarray of object

categoryobject

manager_idinteger (id)

statusarray of object

assignablearray of object

processany

Request

const response = await fetch('/api/1.0/processes/import/validation', {
    method: 'POST',
    headers: {
      "Content-Type": "multipart/form-data"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "process_category_id": 0,
  "name": "text",
  "description": "text",
  "status": [],
  "pause_timer_start": 0,
  "cancel_screen_id": 0,
  "has_timer_start_events": false,
  "request_detail_screen_id": 0,
  "is_valid": 0,
  "package_key": "text",
  "start_events": [
    {
      "parallelMultiple": false,
      "id": "text",
      "name": "text"
    }
  ],
  "warnings": "text",
  "signal_events": [],
  "manager_id": 0,
  "assignable": []
}

Returns the list of files

Display a listing of the resource.

GET/api/1.0/files

Query parameters

filterstring

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

order_bystring

Field to order results by

order_directionenum

ascdesc

per_pageinteger

Response

list of files

Body

dataarray of media (object)

idinteger (id)

Represents media files stored in the database

model_idinteger (id)

model_typestring (id)

collection_namestring

namestring

file_namestring

mime_typestring

diskstring

sizeinteger

manipulationsobject

custom_propertiesobject

responsive_imagesobject

order_columninteger

created_atstring (date-time)

updated_atstring (date-time)

metametadata (object)

filterstring

sort_bystring

sort_orderenum

ascdesc

countinteger

total_pagesinteger

current_pageinteger

forminteger

last_pageinteger

pathstring

per_pageinteger

tointeger

totalinteger

Request

const response = await fetch('/api/1.0/files', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "data": [
    {
      "id": 0,
      "model_id": 0,
      "model_type": "text",
      "collection_name": "text",
      "name": "text",
      "file_name": "text",
      "mime_type": "text",
      "disk": "text",
      "size": 0,
      "order_column": 0,
      "created_at": "2025-01-02T16:36:41.753Z",
      "updated_at": "2025-01-02T16:36:41.753Z"
    }
  ],
  "meta": {
    "filter": "text",
    "sort_by": "text",
    "sort_order": "asc",
    "count": 0,
    "total_pages": 0,
    "current_page": 0,
    "form": 0,
    "last_page": 0,
    "path": "text",
    "per_page": 0,
    "to": 0,
    "total": 0
  }
}

Returns all groups that the user has access to

Display a listing of the resource.

GET/api/1.0/groups

Query parameters

statusenum

ACTIVE or INACTIVE

ACTIVEINACTIVE

filterstring

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

order_bystring

Field to order results by

order_directionenum

ascdesc

per_pageinteger

includestring

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

Response

list of groups

Body

dataarray of groups (all of)

namestring

Represents a group definition.

descriptionstring

manager_idinteger (id)

statusenum

ACTIVEINACTIVE

created_atstring (date-time)

updated_atstring (date-time)

idstring (id)

metametadata (object)

filterstring

sort_bystring

sort_orderenum

ascdesc

countinteger

total_pagesinteger

current_pageinteger

forminteger

last_pageinteger

pathstring

per_pageinteger

tointeger

totalinteger

Request

const response = await fetch('/api/1.0/groups', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "data": [
    {
      "name": "text",
      "description": "text",
      "manager_id": 0,
      "status": "ACTIVE",
      "created_at": "2025-01-02T16:36:41.753Z",
      "updated_at": "2025-01-02T16:36:41.753Z",
      "id": "text"
    }
  ],
  "meta": {
    "filter": "text",
    "sort_by": "text",
    "sort_order": "asc",
    "count": 0,
    "total_pages": 0,
    "current_page": 0,
    "form": 0,
    "last_page": 0,
    "path": "text",
    "per_page": 0,
    "to": 0,
    "total": 0
  }
}

Returns all users of a group

Display the list of groups in a group

GET/api/1.0/groups/{group_id}/groups

Path parameters

group_id*integer

ID of group

Query parameters

filterstring

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

order_directionenum

ascdesc

per_pageinteger

Response

list of members of a group

Body

dataarray of groups (all of)

namestring

Represents a group definition.

descriptionstring

manager_idinteger (id)

statusenum

ACTIVEINACTIVE

created_atstring (date-time)

updated_atstring (date-time)

idstring (id)

metametadata (object)

filterstring

sort_bystring

sort_orderenum

ascdesc

countinteger

total_pagesinteger

current_pageinteger

forminteger

last_pageinteger

pathstring

per_pageinteger

tointeger

totalinteger

Request

const response = await fetch('/api/1.0/groups/{group_id}/groups', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "data": [
    {
      "name": "text",
      "description": "text",
      "manager_id": 0,
      "status": "ACTIVE",
      "created_at": "2025-01-02T16:36:41.753Z",
      "updated_at": "2025-01-02T16:36:41.753Z",
      "id": "text"
    }
  ],
  "meta": {
    "filter": "text",
    "sort_by": "text",
    "sort_order": "asc",
    "count": 0,
    "total_pages": 0,
    "current_page": 0,
    "form": 0,
    "last_page": 0,
    "path": "text",
    "per_page": 0,
    "to": 0,
    "total": 0
  }
}

Returns all groups for a given member

Display a listing of the resource.

GET/api/1.0/group_members

Query parameters

member_idinteger

order_bystring

Field to order results by

order_directionenum

ascdesc

per_pageinteger

Response

list of group_members

Body

dataarray of groupMembers (all of)

group_idstring (id)

Represents a group Members definition.

member_idstring (id)

member_typestring

descriptionstring

idstring (id)

created_atstring (date-time)

updated_atstring (date-time)

metametadata (object)

filterstring

sort_bystring

sort_orderenum

ascdesc

countinteger

total_pagesinteger

current_pageinteger

forminteger

last_pageinteger

pathstring

per_pageinteger

tointeger

totalinteger

Request

const response = await fetch('/api/1.0/group_members', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "data": [
    {
      "group_id": "text",
      "member_id": "text",
      "member_type": "text",
      "description": "text",
      "id": "text",
      "created_at": "2025-01-02T16:36:41.753Z",
      "updated_at": "2025-01-02T16:36:41.753Z"
    }
  ],
  "meta": {
    "filter": "text",
    "sort_by": "text",
    "sort_order": "asc",
    "count": 0,
    "total_pages": 0,
    "current_page": 0,
    "form": 0,
    "last_page": 0,
    "path": "text",
    "per_page": 0,
    "to": 0,
    "total": 0
  }
}

Returns all tasks that the user has access to

Display a listing of the resource.

GET/api/1.0/tasks

Query parameters

process_request_idinteger

Process request id

filterstring

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

order_bystring

Field to order results by

order_directionenum

ascdesc

includestring

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

Response

list of tasks

Body

dataarray of processRequestToken (all of)

user_idstring (id)

ProcessRequestToken is used to store the state of a token of the Nayra engine

statusstring

due_atstring (date-time)

initiated_atstring (date-time)

riskchanges_atstring (date-time)

subprocess_start_event_idstring

dataobject

idstring (id)

process_idstring (id)

process_request_idstring (id)

element_idstring (id)

element_typestring (id)

element_indexstring

element_namestring

created_atstring (date-time)

updated_atstring (date-time)

initiated_atstring (date-time)

advanceStatusstring

due_notifiedinteger

userobject

processobject

process_requestobject

metametadata (object)

filterstring

sort_bystring

sort_orderenum

ascdesc

countinteger

total_pagesinteger

current_pageinteger

forminteger

last_pageinteger

pathstring

per_pageinteger

tointeger

totalinteger

Request

const response = await fetch('/api/1.0/tasks', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "data": [
    {
      "user_id": "text",
      "status": "text",
      "due_at": "2025-01-02T16:36:41.753Z",
      "initiated_at": "2025-01-02T16:36:41.753Z",
      "riskchanges_at": "2025-01-02T16:36:41.753Z",
      "subprocess_start_event_id": "text",
      "id": "text",
      "process_id": "text",
      "process_request_id": "text",
      "element_id": "text",
      "element_type": "text",
      "element_index": "text",
      "element_name": "text",
      "created_at": "2025-01-02T16:36:41.753Z",
      "updated_at": "2025-01-02T16:36:41.753Z",
      "advanceStatus": "text",
      "due_notified": 0
    }
  ],
  "meta": {
    "filter": "text",
    "sort_by": "text",
    "sort_order": "asc",
    "count": 0,
    "total_pages": 0,
    "current_page": 0,
    "form": 0,
    "last_page": 0,
    "path": "text",
    "per_page": 0,
    "to": 0,
    "total": 0
  }
}

Returns the list of files associated with a request

Display a listing of the resource.

GET/api/1.0/requests/{request_id}/files

Path parameters

request_id*integer

ID of the request

Query parameters

filterstring

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

order_bystring

Field to order results by

order_directionenum

ascdesc

per_pageinteger

Response

list of files

Body

dataarray of media (object)

idinteger (id)

Represents media files stored in the database

model_idinteger (id)

model_typestring (id)

collection_namestring

namestring

file_namestring

mime_typestring

diskstring

sizeinteger

manipulationsobject

custom_propertiesobject

responsive_imagesobject

order_columninteger

created_atstring (date-time)

updated_atstring (date-time)

metaobject

filterstring

sort_bystring

sort_orderenum

ascdesc

countinteger

total_pagesinteger

current_pageinteger

forminteger

last_pageinteger

pathstring

per_pageinteger

tointeger

totalinteger

Request

const response = await fetch('/api/1.0/requests/{request_id}/files', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "data": [
    {
      "id": 0,
      "model_id": 0,
      "model_type": "text",
      "collection_name": "text",
      "name": "text",
      "file_name": "text",
      "mime_type": "text",
      "disk": "text",
      "size": 0,
      "order_column": 0,
      "created_at": "2025-01-02T16:36:41.753Z",
      "updated_at": "2025-01-02T16:36:41.753Z"
    }
  ],
  "meta": {
    "filter": "text",
    "sort_by": "text",
    "sort_order": "asc",
    "count": 0,
    "total_pages": 0,
    "current_page": 0,
    "form": 0,
    "last_page": 0,
    "path": "text",
    "per_page": 0,
    "to": 0,
    "total": 0
  }
}

Returns all users of a group

Display the list of users in a group

GET/api/1.0/groups/{group_id}/users

Path parameters

group_id*integer

ID of group

Query parameters

filterstring

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

order_directionenum

ascdesc

per_pageinteger

Response

list of members of a group

Body

dataarray of users (all of)

emailstring (email)

The attributes that are mass assignable.

firstnamestring

lastnamestring

usernamestring

passwordstring

addressstring

citystring

statestring

postalstring

countrystring

phonestring

faxstring

cellstring

titlestring

timezonestring

datetime_formatstring

languagestring

is_administratorboolean

expires_atstring

loggedin_atstring

remember_tokenstring

statusenum

ACTIVEINACTIVESCHEDULEDOUT_OF_OFFICE

fullnamestring

avatarstring

mediaarray of media (object)

idinteger (id)

Represents media files stored in the database

model_idinteger (id)

model_typestring (id)

collection_namestring

namestring

file_namestring

mime_typestring

diskstring

sizeinteger

manipulationsobject

custom_propertiesobject

responsive_imagesobject

order_columninteger

created_atstring (date-time)

updated_atstring (date-time)

birthdatestring (date)

delegation_user_idstring (id)

manager_idstring (id)

metaobject

Other propertiesany

force_change_passwordboolean

idinteger

created_atstring (date-time)

updated_atstring (date-time)

deleted_atstring (date-time)

metametadata (object)

filterstring

sort_bystring

sort_orderenum

ascdesc

countinteger

total_pagesinteger

current_pageinteger

forminteger

last_pageinteger

pathstring

per_pageinteger

tointeger

totalinteger

Request

const response = await fetch('/api/1.0/groups/{group_id}/users', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "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": false,
      "expires_at": "text",
      "loggedin_at": "text",
      "remember_token": "text",
      "status": "ACTIVE",
      "fullname": "text",
      "avatar": "text",
      "media": [
        {
          "id": 0,
          "model_id": 0,
          "model_type": "text",
          "collection_name": "text",
          "name": "text",
          "file_name": "text",
          "mime_type": "text",
          "disk": "text",
          "size": 0,
          "order_column": 0,
          "created_at": "2025-01-02T16:36:41.753Z",
          "updated_at": "2025-01-02T16:36:41.753Z"
        }
      ],
      "birthdate": "2025-01-02",
      "delegation_user_id": "text",
      "manager_id": "text",
      "force_change_password": false,
      "id": 0,
      "created_at": "2025-01-02T16:36:41.753Z",
      "updated_at": "2025-01-02T16:36:41.753Z",
      "deleted_at": "2025-01-02T16:36:41.753Z"
    }
  ],
  "meta": {
    "filter": "text",
    "sort_by": "text",
    "sort_order": "asc",
    "count": 0,
    "total_pages": 0,
    "current_page": 0,
    "form": 0,
    "last_page": 0,
    "path": "text",
    "per_page": 0,
    "to": 0,
    "total": 0
  }
}

Returns all users available for a given group

Display a listing of users available

GET/api/1.0/user_members_available

Path parameters

group_id*string

ID of group to return

Query parameters

filterstring

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

order_bystring

Field to order results by

order_directionenum

ascdesc

per_pageinteger

Response

list of users available to be assigned as member

Body

dataarray of users (all of)

emailstring (email)

The attributes that are mass assignable.

firstnamestring

lastnamestring

usernamestring

passwordstring

addressstring

citystring

statestring

postalstring

countrystring

phonestring

faxstring

cellstring

titlestring

timezonestring

datetime_formatstring

languagestring

is_administratorboolean

expires_atstring

loggedin_atstring

remember_tokenstring

statusenum

ACTIVEINACTIVESCHEDULEDOUT_OF_OFFICE

fullnamestring

avatarstring

mediaarray of media (object)

idinteger (id)

Represents media files stored in the database

model_idinteger (id)

model_typestring (id)

collection_namestring

namestring

file_namestring

mime_typestring

diskstring

sizeinteger

manipulationsobject

custom_propertiesobject

responsive_imagesobject

order_columninteger

created_atstring (date-time)

updated_atstring (date-time)

birthdatestring (date)

delegation_user_idstring (id)

manager_idstring (id)

metaobject

Other propertiesany

force_change_passwordboolean

idinteger

created_atstring (date-time)

updated_atstring (date-time)

deleted_atstring (date-time)

metametadata (object)

filterstring

sort_bystring

sort_orderenum

ascdesc

countinteger

total_pagesinteger

current_pageinteger

forminteger

last_pageinteger

pathstring

per_pageinteger

tointeger

totalinteger

Request

const response = await fetch('/api/1.0/user_members_available', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "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": false,
      "expires_at": "text",
      "loggedin_at": "text",
      "remember_token": "text",
      "status": "ACTIVE",
      "fullname": "text",
      "avatar": "text",
      "media": [
        {
          "id": 0,
          "model_id": 0,
          "model_type": "text",
          "collection_name": "text",
          "name": "text",
          "file_name": "text",
          "mime_type": "text",
          "disk": "text",
          "size": 0,
          "order_column": 0,
          "created_at": "2025-01-02T16:36:41.753Z",
          "updated_at": "2025-01-02T16:36:41.753Z"
        }
      ],
      "birthdate": "2025-01-02",
      "delegation_user_id": "text",
      "manager_id": "text",
      "force_change_password": false,
      "id": 0,
      "created_at": "2025-01-02T16:36:41.753Z",
      "updated_at": "2025-01-02T16:36:41.753Z",
      "deleted_at": "2025-01-02T16:36:41.753Z"
    }
  ],
  "meta": {
    "filter": "text",
    "sort_by": "text",
    "sort_order": "asc",
    "count": 0,
    "total_pages": 0,
    "current_page": 0,
    "form": 0,
    "last_page": 0,
    "path": "text",
    "per_page": 0,
    "to": 0,
    "total": 0
  }
}

Returns all users

Display a listing of the resource.

GET/api/1.0/users

Query parameters

statusenum

ACTIVE or INACTIVE

ACTIVEINACTIVE

filterstring

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

order_bystring

Field to order results by

order_directionenum

ascdesc

per_pageinteger

includestring

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

exclude_idsstring

Comma separated list of IDs to exclude from the response

Response

list of users

Body

dataarray of users (all of)

emailstring (email)

The attributes that are mass assignable.

firstnamestring

lastnamestring

usernamestring

passwordstring

addressstring

citystring

statestring

postalstring

countrystring

phonestring

faxstring

cellstring

titlestring

timezonestring

datetime_formatstring

languagestring

is_administratorboolean

expires_atstring

loggedin_atstring

remember_tokenstring

statusenum

ACTIVEINACTIVESCHEDULEDOUT_OF_OFFICE

fullnamestring

avatarstring

mediaarray of media (object)

idinteger (id)

Represents media files stored in the database

model_idinteger (id)

model_typestring (id)

collection_namestring

namestring

file_namestring

mime_typestring

diskstring

sizeinteger

manipulationsobject

custom_propertiesobject

responsive_imagesobject

order_columninteger

created_atstring (date-time)

updated_atstring (date-time)

birthdatestring (date)

delegation_user_idstring (id)

manager_idstring (id)

metaobject

Other propertiesany

force_change_passwordboolean

idinteger

created_atstring (date-time)

updated_atstring (date-time)

deleted_atstring (date-time)

metametadata (object)

filterstring

sort_bystring

sort_orderenum

ascdesc

countinteger

total_pagesinteger

current_pageinteger

forminteger

last_pageinteger

pathstring

per_pageinteger

tointeger

totalinteger

Request

const response = await fetch('/api/1.0/users', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "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": false,
      "expires_at": "text",
      "loggedin_at": "text",
      "remember_token": "text",
      "status": "ACTIVE",
      "fullname": "text",
      "avatar": "text",
      "media": [
        {
          "id": 0,
          "model_id": 0,
          "model_type": "text",
          "collection_name": "text",
          "name": "text",
          "file_name": "text",
          "mime_type": "text",
          "disk": "text",
          "size": 0,
          "order_column": 0,
          "created_at": "2025-01-02T16:36:41.753Z",
          "updated_at": "2025-01-02T16:36:41.753Z"
        }
      ],
      "birthdate": "2025-01-02",
      "delegation_user_id": "text",
      "manager_id": "text",
      "force_change_password": false,
      "id": 0,
      "created_at": "2025-01-02T16:36:41.753Z",
      "updated_at": "2025-01-02T16:36:41.753Z",
      "deleted_at": "2025-01-02T16:36:41.753Z"
    }
  ],
  "meta": {
    "filter": "text",
    "sort_by": "text",
    "sort_order": "asc",
    "count": 0,
    "total_pages": 0,
    "current_page": 0,
    "form": 0,
    "last_page": 0,
    "path": "text",
    "per_page": 0,
    "to": 0,
    "total": 0
  }
}

Save a new process

Store a newly created resource in storage.

POST/api/1.0/processes

Body

process_category_idinteger (id)

Represents a business process definition.

namestring

descriptionstring

statusenum

ACTIVEINACTIVEARCHIVED

pause_timer_startinteger

cancel_screen_idinteger

has_timer_start_eventsboolean

request_detail_screen_idinteger (id)

is_validinteger

package_keystring

start_eventsarray of ProcessStartEvents (object)

eventDefinitionsobject

parallelMultipleboolean

outgoingobject

incomingobject

idstring

namestring

warningsstring

self_service_tasksobject

signal_eventsarray of object

categoryobject

manager_idinteger (id)

Response

success

Body

process_category_idinteger (id)

Represents a business process definition.

namestring

descriptionstring

statusenum

ACTIVEINACTIVEARCHIVED

pause_timer_startinteger

cancel_screen_idinteger

has_timer_start_eventsboolean

request_detail_screen_idinteger (id)

is_validinteger

package_keystring

start_eventsarray of ProcessStartEvents (object)

eventDefinitionsobject

parallelMultipleboolean

outgoingobject

incomingobject

idstring

namestring

warningsstring

self_service_tasksobject

signal_eventsarray of object

categoryobject

manager_idinteger (id)

user_idinteger (id)

idstring (id)

deleted_atstring (date-time)

created_atstring (date-time)

updated_atstring (date-time)

notificationsobject

task_notificationsobject

Request

const response = await fetch('/api/1.0/processes', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "process_category_id": 0,
  "name": "text",
  "description": "text",
  "status": "ACTIVE",
  "pause_timer_start": 0,
  "cancel_screen_id": 0,
  "has_timer_start_events": false,
  "request_detail_screen_id": 0,
  "is_valid": 0,
  "package_key": "text",
  "start_events": [
    {
      "parallelMultiple": false,
      "id": "text",
      "name": "text"
    }
  ],
  "warnings": "text",
  "signal_events": [],
  "manager_id": 0,
  "user_id": 0,
  "id": "text",
  "deleted_at": "2025-01-02T16:36:41.753Z",
  "created_at": "2025-01-02T16:36:41.753Z",
  "updated_at": "2025-01-02T16:36:41.753Z"
}

Display listing of access tokens for the specified user.

GET/api/1.0/users/{user_id}/tokens

Path parameters

user_id*integer

User id

Query parameters

per_pageinteger

Response

List of tokens.

Body

dataarray of UserToken (object)

idstring

user_idinteger

client_idinteger

namestring

scopesobject

revokedboolean

clientTokenClient (object)

idinteger

user_idinteger

namestring

providerstring

redirectstring

personal_access_clientboolean

password_clientboolean

revokedboolean

created_atstring (date-time)

updated_atstring (date-time)

created_atstring (date-time)

updated_atstring (date-time)

expires_atstring (date-time)

metametadata (object)

filterstring

sort_bystring

sort_orderenum

ascdesc

countinteger

total_pagesinteger

current_pageinteger

forminteger

last_pageinteger

pathstring

per_pageinteger

tointeger

totalinteger

Request

const response = await fetch('/api/1.0/users/{user_id}/tokens', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "data": [
    {
      "id": "text",
      "user_id": 0,
      "client_id": 0,
      "name": "text",
      "revoked": false,
      "client": {
        "id": 0,
        "user_id": 0,
        "name": "text",
        "provider": "text",
        "redirect": "text",
        "personal_access_client": false,
        "password_client": false,
        "revoked": false,
        "created_at": "2025-01-02T16:36:41.753Z",
        "updated_at": "2025-01-02T16:36:41.753Z"
      },
      "created_at": "2025-01-02T16:36:41.753Z",
      "updated_at": "2025-01-02T16:36:41.753Z",
      "expires_at": "2025-01-02T16:36:41.753Z"
    }
  ],
  "meta": {
    "filter": "text",
    "sort_by": "text",
    "sort_order": "asc",
    "count": 0,
    "total_pages": 0,
    "current_page": 0,
    "form": 0,
    "last_page": 0,
    "path": "text",
    "per_page": 0,
    "to": 0,
    "total": 0
  }
}

Returns all groups available for a given member

Display a listing of groups available

GET/api/1.0/group_members_available

Path parameters

member_id*string

ID of group member to return

member_type*string

type of group member to return

Query parameters

filterstring

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

order_bystring

Field to order results by

order_directionenum

ascdesc

per_pageinteger

Response

list of groups available to be assigned as member

Body

dataarray of availableGroupMembers (all of)

idstring (id)

descriptionstring

namestring

statusenum

ACTIVEINACTIVE

created_atstring (date-time)

updated_atstring (date-time)

metametadata (object)

filterstring

sort_bystring

sort_orderenum

ascdesc

countinteger

total_pagesinteger

current_pageinteger

forminteger

last_pageinteger

pathstring

per_pageinteger

tointeger

totalinteger

Request

const response = await fetch('/api/1.0/group_members_available', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "data": [
    {
      "id": "text",
      "description": "text",
      "name": "text",
      "status": "ACTIVE",
      "created_at": "2025-01-02T16:36:41.753Z",
      "updated_at": "2025-01-02T16:36:41.753Z"
    }
  ],
  "meta": {
    "filter": "text",
    "sort_by": "text",
    "sort_order": "asc",
    "count": 0,
    "total_pages": 0,
    "current_page": 0,
    "form": 0,
    "last_page": 0,
    "path": "text",
    "per_page": 0,
    "to": 0,
    "total": 0
  }
}

Returns all processes that the user has access to

Get list Process

GET/api/1.0/processes

Query parameters

filterstring

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

order_bystring

Field to order results by

order_directionenum

ascdesc

per_pageinteger

statusenum

ACTIVE or INACTIVE

ACTIVEINACTIVE

includestring

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

Response

list of processes

Body

dataarray of Process (all of)

process_category_idinteger (id)

Represents a business process definition.

namestring

descriptionstring

statusenum

ACTIVEINACTIVEARCHIVED

pause_timer_startinteger

cancel_screen_idinteger

has_timer_start_eventsboolean

request_detail_screen_idinteger (id)

is_validinteger

package_keystring

start_eventsarray of ProcessStartEvents (object)

eventDefinitionsobject

parallelMultipleboolean

outgoingobject

incomingobject

idstring

namestring

warningsstring

self_service_tasksobject

signal_eventsarray of object

categoryobject

manager_idinteger (id)

user_idinteger (id)

idstring (id)

deleted_atstring (date-time)

created_atstring (date-time)

updated_atstring (date-time)

notificationsobject

task_notificationsobject

metametadata (object)

filterstring

sort_bystring

sort_orderenum

ascdesc

countinteger

total_pagesinteger

current_pageinteger

forminteger

last_pageinteger

pathstring

per_pageinteger

tointeger

totalinteger

Request

const response = await fetch('/api/1.0/processes', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "data": [
    {
      "process_category_id": 0,
      "name": "text",
      "description": "text",
      "status": "ACTIVE",
      "pause_timer_start": 0,
      "cancel_screen_id": 0,
      "has_timer_start_events": false,
      "request_detail_screen_id": 0,
      "is_valid": 0,
      "package_key": "text",
      "start_events": [
        {
          "parallelMultiple": false,
          "id": "text",
          "name": "text"
        }
      ],
      "warnings": "text",
      "signal_events": [],
      "manager_id": 0,
      "user_id": 0,
      "id": "text",
      "deleted_at": "2025-01-02T16:36:41.753Z",
      "created_at": "2025-01-02T16:36:41.753Z",
      "updated_at": "2025-01-02T16:36:41.753Z"
    }
  ],
  "meta": {
    "filter": "text",
    "sort_by": "text",
    "sort_order": "asc",
    "count": 0,
    "total_pages": 0,
    "current_page": 0,
    "form": 0,
    "last_page": 0,
    "path": "text",
    "per_page": 0,
    "to": 0,
    "total": 0
  }
}

Update a task

Updates the current element

PUT/api/1.0/tasks/{task_id}

Path parameters

task_id*integer

ID of task to update

Body

status*string

Example: "COMPLETED"

data*object

Response

success

Body

user_idstring (id)

ProcessRequestToken is used to store the state of a token of the Nayra engine

statusstring

due_atstring (date-time)

initiated_atstring (date-time)

riskchanges_atstring (date-time)

subprocess_start_event_idstring

dataobject

idstring (id)

process_idstring (id)

process_request_idstring (id)

element_idstring (id)

element_typestring (id)

element_indexstring

element_namestring

created_atstring (date-time)

updated_atstring (date-time)

initiated_atstring (date-time)

advanceStatusstring

due_notifiedinteger

userobject

processobject

process_requestobject

Request

const response = await fetch('/api/1.0/tasks/{task_id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "status": "COMPLETED"
    }),
});
const data = await response.json();

Response

{
  "user_id": "text",
  "status": "text",
  "due_at": "2025-01-02T16:36:41.753Z",
  "initiated_at": "2025-01-02T16:36:41.753Z",
  "riskchanges_at": "2025-01-02T16:36:41.753Z",
  "subprocess_start_event_id": "text",
  "id": "text",
  "process_id": "text",
  "process_request_id": "text",
  "element_id": "text",
  "element_type": "text",
  "element_index": "text",
  "element_name": "text",
  "created_at": "2025-01-02T16:36:41.753Z",
  "updated_at": "2025-01-02T16:36:41.753Z",
  "advanceStatus": "text",
  "due_notified": 0
}

Returns all process Requests that the user has access to

Display a listing of the resource.

GET/api/1.0/requests

Query parameters

typeenum

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

allin_progresscompletedstarted_me

filterstring

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

order_bystring

Field to order results by

order_directionenum

ascdesc

per_pageinteger

includestring

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

Response

list of processes

Body

dataarray of processRequest (all of)

user_idstring (id)

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

callable_idstring (id)

dataobject

statusenum

ACTIVECOMPLETEDERRORCANCELED

namestring

process_idinteger

processobject

idstring (id)

process_idstring (id)

process_collaboration_idstring (id)

participant_idstring (id)

process_category_idstring (id)

created_atstring (date-time)

updated_atstring (date-time)

userany

participantsarray of users (all of)

emailstring (email)

The attributes that are mass assignable.

firstnamestring

lastnamestring

usernamestring

passwordstring

addressstring

citystring

statestring

postalstring

countrystring

phonestring

faxstring

cellstring

titlestring

timezonestring

datetime_formatstring

languagestring

is_administratorboolean

expires_atstring

loggedin_atstring

remember_tokenstring

statusenum

ACTIVEINACTIVESCHEDULEDOUT_OF_OFFICE

fullnamestring

avatarstring

mediaarray of media (object)

idinteger (id)

Represents media files stored in the database

model_idinteger (id)

model_typestring (id)

collection_namestring

namestring

file_namestring

mime_typestring

diskstring

sizeinteger

manipulationsobject

custom_propertiesobject

responsive_imagesobject

order_columninteger

created_atstring (date-time)

updated_atstring (date-time)

birthdatestring (date)

delegation_user_idstring (id)

manager_idstring (id)

metaobject

Other propertiesany

force_change_passwordboolean

idinteger

created_atstring (date-time)

updated_atstring (date-time)

deleted_atstring (date-time)

metametadata (object)

filterstring

sort_bystring

sort_orderenum

ascdesc

countinteger

total_pagesinteger

current_pageinteger

forminteger

last_pageinteger

pathstring

per_pageinteger

tointeger

totalinteger

Request

const response = await fetch('/api/1.0/requests', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "data": [
    {
      "user_id": "text",
      "callable_id": "text",
      "status": "ACTIVE",
      "name": "text",
      "process_id": "text",
      "id": "text",
      "process_collaboration_id": "text",
      "participant_id": "text",
      "process_category_id": "text",
      "created_at": "2025-01-02T16:36:41.753Z",
      "updated_at": "2025-01-02T16:36:41.753Z",
      "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": false,
          "expires_at": "text",
          "loggedin_at": "text",
          "remember_token": "text",
          "status": "ACTIVE",
          "fullname": "text",
          "avatar": "text",
          "media": [
            {
              "id": 0,
              "model_id": 0,
              "model_type": "text",
              "collection_name": "text",
              "name": "text",
              "file_name": "text",
              "mime_type": "text",
              "disk": "text",
              "size": 0,
              "order_column": 0,
              "created_at": "2025-01-02T16:36:41.753Z",
              "updated_at": "2025-01-02T16:36:41.753Z"
            }
          ],
          "birthdate": "2025-01-02",
          "delegation_user_id": "text",
          "manager_id": "text",
          "force_change_password": false,
          "id": 0,
          "created_at": "2025-01-02T16:36:41.753Z",
          "updated_at": "2025-01-02T16:36:41.753Z",
          "deleted_at": "2025-01-02T16:36:41.753Z"
        }
      ]
    }
  ],
  "meta": {
    "filter": "text",
    "sort_by": "text",
    "sort_order": "asc",
    "count": 0,
    "total_pages": 0,
    "current_page": 0,
    "form": 0,
    "last_page": 0,
    "path": "text",
    "per_page": 0,
    "to": 0,
    "total": 0
  }
}

Returns the list of processes that the user can start

Returns the list of processes that the user can start.

GET/api/1.0/start_processes

Path parameters

without_event_definitionsboolean

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

Query parameters

filterstring

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

order_bystring

Field to order results by

order_directionenum

ascdesc

per_pageinteger

includestring

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

Response

list of processes that the user can start

Body

dataarray of ProcessWithStartEvents (all of)

process_category_idinteger (id)

Represents a business process definition.

namestring

descriptionstring

statusenum

ACTIVEINACTIVEARCHIVED

pause_timer_startinteger

cancel_screen_idinteger

has_timer_start_eventsboolean

request_detail_screen_idinteger (id)

is_validinteger

package_keystring

start_eventsarray of ProcessStartEvents (object)

eventDefinitionsobject

parallelMultipleboolean

outgoingobject

incomingobject

idstring

namestring

warningsstring

self_service_tasksobject

signal_eventsarray of object

categoryobject

manager_idinteger (id)

user_idinteger (id)

idstring (id)

deleted_atstring (date-time)

created_atstring (date-time)

updated_atstring (date-time)

notificationsobject

task_notificationsobject

eventsarray of ProcessStartEvents (object)

eventDefinitionsobject

parallelMultipleboolean

outgoingobject

incomingobject

idstring

namestring

metametadata (object)

filterstring

sort_bystring

sort_orderenum

ascdesc

countinteger

total_pagesinteger

current_pageinteger

forminteger

last_pageinteger

pathstring

per_pageinteger

tointeger

totalinteger

Request

const response = await fetch('/api/1.0/start_processes', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "data": [
    {
      "process_category_id": 0,
      "name": "text",
      "description": "text",
      "status": "ACTIVE",
      "pause_timer_start": 0,
      "cancel_screen_id": 0,
      "has_timer_start_events": false,
      "request_detail_screen_id": 0,
      "is_valid": 0,
      "package_key": "text",
      "start_events": [
        {
          "parallelMultiple": false,
          "id": "text",
          "name": "text"
        }
      ],
      "warnings": "text",
      "signal_events": [],
      "manager_id": 0,
      "user_id": 0,
      "id": "text",
      "deleted_at": "2025-01-02T16:36:41.753Z",
      "created_at": "2025-01-02T16:36:41.753Z",
      "updated_at": "2025-01-02T16:36:41.753Z",
      "events": [
        {
          "parallelMultiple": false,
          "id": "text",
          "name": "text"
        }
      ]
    }
  ],
  "meta": {
    "filter": "text",
    "sort_by": "text",
    "sort_order": "asc",
    "count": 0,
    "total_pages": 0,
    "current_page": 0,
    "form": 0,
    "last_page": 0,
    "path": "text",
    "per_page": 0,
    "to": 0,
    "total": 0
  }
}

Save a new users

Store a newly created resource in storage.

POST/api/1.0/users

Body

emailstring (email)

The attributes that are mass assignable.

firstnamestring

lastnamestring

usernamestring

passwordstring

addressstring

citystring

statestring

postalstring

countrystring

phonestring

faxstring

cellstring

titlestring

timezonestring

datetime_formatstring

languagestring

is_administratorboolean

expires_atstring

loggedin_atstring

remember_tokenstring

statusenum

ACTIVEINACTIVESCHEDULEDOUT_OF_OFFICE

fullnamestring

avatarstring

mediaarray of media (object)

idinteger (id)

Represents media files stored in the database

model_idinteger (id)

model_typestring (id)

collection_namestring

namestring

file_namestring

mime_typestring

diskstring

sizeinteger

manipulationsobject

custom_propertiesobject

responsive_imagesobject

order_columninteger

created_atstring (date-time)

updated_atstring (date-time)

birthdatestring (date)

delegation_user_idstring (id)

manager_idstring (id)

metaobject

Other propertiesany

force_change_passwordboolean

Response

success

Body

emailstring (email)

The attributes that are mass assignable.

firstnamestring

lastnamestring

usernamestring

passwordstring

addressstring

citystring

statestring

postalstring

countrystring

phonestring

faxstring

cellstring

titlestring

timezonestring

datetime_formatstring

languagestring

is_administratorboolean

expires_atstring

loggedin_atstring

remember_tokenstring

statusenum

ACTIVEINACTIVESCHEDULEDOUT_OF_OFFICE

fullnamestring

avatarstring

mediaarray of media (object)

idinteger (id)

Represents media files stored in the database

model_idinteger (id)

model_typestring (id)

collection_namestring

namestring

file_namestring

mime_typestring

diskstring

sizeinteger

manipulationsobject

custom_propertiesobject

responsive_imagesobject

order_columninteger

created_atstring (date-time)

updated_atstring (date-time)

birthdatestring (date)

delegation_user_idstring (id)

manager_idstring (id)

metaobject

Other propertiesany

force_change_passwordboolean

idinteger

created_atstring (date-time)

updated_atstring (date-time)

deleted_atstring (date-time)

Request

const response = await fetch('/api/1.0/users', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "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": false,
  "expires_at": "text",
  "loggedin_at": "text",
  "remember_token": "text",
  "status": "ACTIVE",
  "fullname": "text",
  "avatar": "text",
  "media": [
    {
      "id": 0,
      "model_id": 0,
      "model_type": "text",
      "collection_name": "text",
      "name": "text",
      "file_name": "text",
      "mime_type": "text",
      "disk": "text",
      "size": 0,
      "order_column": 0,
      "created_at": "2025-01-02T16:36:41.753Z",
      "updated_at": "2025-01-02T16:36:41.753Z"
    }
  ],
  "birthdate": "2025-01-02",
  "delegation_user_id": "text",
  "manager_id": "text",
  "force_change_password": false,
  "id": 0,
  "created_at": "2025-01-02T16:36:41.753Z",
  "updated_at": "2025-01-02T16:36:41.753Z",
  "deleted_at": "2025-01-02T16:36:41.753Z"
}

Get single user by ID

Display the specified resource.

GET/api/1.0/users/{user_id}

Path parameters

user_id*integer

ID of user to return

Response

Successfully found the process

Body

emailstring (email)

The attributes that are mass assignable.

firstnamestring

lastnamestring

usernamestring

passwordstring

addressstring

citystring

statestring

postalstring

countrystring

phonestring

faxstring

cellstring

titlestring

timezonestring

datetime_formatstring

languagestring

is_administratorboolean

expires_atstring

loggedin_atstring

remember_tokenstring

statusenum

ACTIVEINACTIVESCHEDULEDOUT_OF_OFFICE

fullnamestring

avatarstring

mediaarray of media (object)

idinteger (id)

Represents media files stored in the database

model_idinteger (id)

model_typestring (id)

collection_namestring

namestring

file_namestring

mime_typestring

diskstring

sizeinteger

manipulationsobject

custom_propertiesobject

responsive_imagesobject

order_columninteger

created_atstring (date-time)

updated_atstring (date-time)

birthdatestring (date)

delegation_user_idstring (id)

manager_idstring (id)

metaobject

Other propertiesany

force_change_passwordboolean

idinteger

created_atstring (date-time)

updated_atstring (date-time)

deleted_atstring (date-time)

Request

const response = await fetch('/api/1.0/users/{user_id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "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": false,
  "expires_at": "text",
  "loggedin_at": "text",
  "remember_token": "text",
  "status": "ACTIVE",
  "fullname": "text",
  "avatar": "text",
  "media": [
    {
      "id": 0,
      "model_id": 0,
      "model_type": "text",
      "collection_name": "text",
      "name": "text",
      "file_name": "text",
      "mime_type": "text",
      "disk": "text",
      "size": 0,
      "order_column": 0,
      "created_at": "2025-01-02T16:36:41.753Z",
      "updated_at": "2025-01-02T16:36:41.753Z"
    }
  ],
  "birthdate": "2025-01-02",
  "delegation_user_id": "text",
  "manager_id": "text",
  "force_change_password": false,
  "id": 0,
  "created_at": "2025-01-02T16:36:41.753Z",
  "updated_at": "2025-01-02T16:36:41.753Z",
  "deleted_at": "2025-01-02T16:36:41.753Z"
}

Update a user

PUT/api/1.0/users/{user_id}

Path parameters

user_id*integer

ID of user to return

Body

emailstring (email)

The attributes that are mass assignable.

firstnamestring

lastnamestring

usernamestring

passwordstring

addressstring

citystring

statestring

postalstring

countrystring

phonestring

faxstring

cellstring

titlestring

timezonestring

datetime_formatstring

languagestring

is_administratorboolean

expires_atstring

loggedin_atstring

remember_tokenstring

statusenum

ACTIVEINACTIVESCHEDULEDOUT_OF_OFFICE

fullnamestring

avatarstring

mediaarray of media (object)

idinteger (id)

Represents media files stored in the database

model_idinteger (id)

model_typestring (id)

collection_namestring

namestring

file_namestring

mime_typestring

diskstring

sizeinteger

manipulationsobject

custom_propertiesobject

responsive_imagesobject

order_columninteger

created_atstring (date-time)

updated_atstring (date-time)

birthdatestring (date)

delegation_user_idstring (id)

manager_idstring (id)

metaobject

Other propertiesany

force_change_passwordboolean

Response

success

Request

const response = await fetch('/api/1.0/users/{user_id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "error": "text"
}

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

Versions

Tools

Postman Collection

Users

Delete a user

Set the groups a users belongs to

Restore a soft deleted user

Delete a token

Groups

Create or update a new setting

Delete a group

Delete a group member

Requests

Create or update a new setting

Update a process request event

Save a new media file to a request

Get a file uploaded to a request

Delete all media associated with a request

Processes

Get single process category by ID

Delete a process

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

Check if the import is ready

Update assignments after import

Notifications

Environment Variables

Files

Screens

Tasks

ProcessMaker Platform RESTful API

Overview

Test API Endpoints from the API Documentation

Make API Calls with the Data Connector

Delete a notification

Mark notifications as read by the user

Mark notifications as unread by the user

Mark notifications as read by id and type

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

Delete an environment variable

Create or update a new setting

Delete a media file

Get the contents of a file

Create or update a new setting

Delete a screen category

Delete a screen

Export a single screen by ID

Import a new screen

Create or update a new setting

Collections

Returns all collections that the user has access to

Save a new collections

Get single collections by ID

Update a collection

Delete a collection

Trigger export collections job

Import a new collection

Deletes all records in a collection