processmaker.com Knowledge Center ProcessMaker University

Groups

API Reference for ProcessMaker Group API

PreviousUsers NextRequests

Last updated 3 months ago

Was this helpful?

Get single group by ID

get

Display the specified resource.

Authorizations

Path parameters

group_idintegerrequired

ID of group to return

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/1.0/groups/{group_id}'

200

404

{
  "name": "text",
  "description": "text",
  "manager_id": 1,
  "status": "ACTIVE",
  "created_at": "2025-03-28T02:07:55.928Z",
  "updated_at": "2025-03-28T02:07:55.928Z",
  "id": "text"
}

Successfully found the group

Delete a group

delete

Delete a user

Authorizations

Path parameters

group_idintegerrequired

ID of group to return

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/api/1.0/groups/{group_id}'

204

404

No body

success

Returns all users of a group

get

Display the list of users in a group

Authorizations

Path parameters

group_idintegerrequired

ID of group

Query parameters

filterstringoptional

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

order_directionstring · enum · default: "asc"optional

Options: asc, desc

per_pageinteger · default: "10"optional

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/1.0/groups/{group_id}/users'

200

{
  "data": [
    {
      "email": "name@gmail.com",
      "firstname": "text",
      "lastname": "text",
      "username": "text",
      "password": "text",
      "address": "text",
      "city": "text",
      "state": "text",
      "postal": "text",
      "country": "text",
      "phone": "text",
      "fax": "text",
      "cell": "text",
      "title": "text",
      "timezone": "text",
      "datetime_format": "text",
      "language": "text",
      "is_administrator": true,
      "expires_at": "text",
      "loggedin_at": "text",
      "remember_token": "text",
      "status": "ACTIVE",
      "fullname": "text",
      "avatar": "text",
      "media": [
        {
          "id": 1,
          "model_id": 1,
          "model_type": "text",
          "collection_name": "text",
          "name": "text",
          "file_name": "text",
          "mime_type": "text",
          "disk": "text",
          "size": 1,
          "manipulations": {},
          "custom_properties": {},
          "responsive_images": {},
          "order_column": 1,
          "created_at": "2025-03-28T02:07:55.928Z",
          "updated_at": "2025-03-28T02:07:55.928Z"
        }
      ],
      "birthdate": "2025-03-28",
      "delegation_user_id": "text",
      "manager_id": "text",
      "meta": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "force_change_password": true,
      "id": 1,
      "created_at": "2025-03-28T02:07:55.928Z",
      "updated_at": "2025-03-28T02:07:55.928Z",
      "deleted_at": "2025-03-28T02:07:55.928Z"
    }
  ],
  "meta": {
    "filter": "text",
    "sort_by": "text",
    "sort_order": "asc",
    "count": 1,
    "total_pages": 1,
    "current_page": 1,
    "form": 1,
    "last_page": 1,
    "path": "text",
    "per_page": 1,
    "to": 1,
    "total": 1
  }
}

list of members of a group

Returns all users of a group

get

Display the list of groups in a group

Authorizations

Path parameters

group_idintegerrequired

ID of group

Query parameters

filterstringoptional

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

order_directionstring · enum · default: "asc"optional

Options: asc, desc

per_pageinteger · default: "10"optional

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/1.0/groups/{group_id}/groups'

200

{
  "data": [
    {
      "name": "text",
      "description": "text",
      "manager_id": 1,
      "status": "ACTIVE",
      "created_at": "2025-03-28T02:07:55.928Z",
      "updated_at": "2025-03-28T02:07:55.928Z",
      "id": "text"
    }
  ],
  "meta": {
    "filter": "text",
    "sort_by": "text",
    "sort_order": "asc",
    "count": 1,
    "total_pages": 1,
    "current_page": 1,
    "form": 1,
    "last_page": 1,
    "path": "text",
    "per_page": 1,
    "to": 1,
    "total": 1
  }
}

list of members of a group

Returns all groups for a given member

get

Display a listing of the resource.

Authorizations

Query parameters

member_idintegeroptional

order_bystringoptional

Field to order results by

order_directionstring · enum · default: "asc"optional

Options: asc, desc

per_pageinteger · default: "10"optional

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

{
  "data": [
    {
      "group_id": "text",
      "member_id": "text",
      "member_type": "text",
      "description": "text",
      "id": "text",
      "created_at": "2025-03-28T02:07:55.928Z",
      "updated_at": "2025-03-28T02:07:55.928Z"
    }
  ],
  "meta": {
    "filter": "text",
    "sort_by": "text",
    "sort_order": "asc",
    "count": 1,
    "total_pages": 1,
    "current_page": 1,
    "form": 1,
    "last_page": 1,
    "path": "text",
    "per_page": 1,
    "to": 1,
    "total": 1
  }
}

list of group_members

Get single group member by ID

get

Display the specified resource.

Authorizations

Path parameters

group_member_idstringrequired

ID of group members to return

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/1.0/group_members/{group_member_id}'

200

{
  "group_id": "text",
  "member_id": "text",
  "member_type": "text",
  "id": "text",
  "created_at": "2025-03-28T02:07:55.928Z",
  "updated_at": "2025-03-28T02:07:55.928Z"
}

Successfully found the group members

Delete a group member

delete

Delete a group membership

Authorizations

Path parameters

group_member_idstringrequired

ID of group_members to return

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/api/1.0/group_members/{group_member_id}'

204

No body

success

Returns all groups available for a given member

get

Display a listing of groups available

Authorizations

Path parameters

member_idstringrequired

ID of group member to return

member_typestringrequired

type of group member to return

Query parameters

filterstringoptional

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

order_bystringoptional

Field to order results by

order_directionstring · enum · default: "asc"optional

Options: asc, desc

per_pageinteger · default: "10"optional

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

{
  "data": [
    {
      "id": "text",
      "description": "text",
      "name": "text",
      "status": "ACTIVE",
      "created_at": "2025-03-28T02:07:55.928Z",
      "updated_at": "2025-03-28T02:07:55.928Z"
    }
  ],
  "meta": {
    "filter": "text",
    "sort_by": "text",
    "sort_order": "asc",
    "count": 1,
    "total_pages": 1,
    "current_page": 1,
    "form": 1,
    "last_page": 1,
    "path": "text",
    "per_page": 1,
    "to": 1,
    "total": 1
  }
}

list of groups available to be assigned as member

Returns all users available for a given group

get

Display a listing of users available

Authorizations

Path parameters

group_idstringrequired

ID of group to return

Query parameters

filterstringoptional

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

order_bystringoptional

Field to order results by

order_directionstring · enum · default: "asc"optional

Options: asc, desc

per_pageinteger · default: "10"optional

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

{
  "data": [
    {
      "email": "name@gmail.com",
      "firstname": "text",
      "lastname": "text",
      "username": "text",
      "password": "text",
      "address": "text",
      "city": "text",
      "state": "text",
      "postal": "text",
      "country": "text",
      "phone": "text",
      "fax": "text",
      "cell": "text",
      "title": "text",
      "timezone": "text",
      "datetime_format": "text",
      "language": "text",
      "is_administrator": true,
      "expires_at": "text",
      "loggedin_at": "text",
      "remember_token": "text",
      "status": "ACTIVE",
      "fullname": "text",
      "avatar": "text",
      "media": [
        {
          "id": 1,
          "model_id": 1,
          "model_type": "text",
          "collection_name": "text",
          "name": "text",
          "file_name": "text",
          "mime_type": "text",
          "disk": "text",
          "size": 1,
          "manipulations": {},
          "custom_properties": {},
          "responsive_images": {},
          "order_column": 1,
          "created_at": "2025-03-28T02:07:55.928Z",
          "updated_at": "2025-03-28T02:07:55.928Z"
        }
      ],
      "birthdate": "2025-03-28",
      "delegation_user_id": "text",
      "manager_id": "text",
      "meta": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "force_change_password": true,
      "id": 1,
      "created_at": "2025-03-28T02:07:55.928Z",
      "updated_at": "2025-03-28T02:07:55.928Z",
      "deleted_at": "2025-03-28T02:07:55.928Z"
    }
  ],
  "meta": {
    "filter": "text",
    "sort_by": "text",
    "sort_order": "asc",
    "count": 1,
    "total_pages": 1,
    "current_page": 1,
    "form": 1,
    "last_page": 1,
    "path": "text",
    "per_page": 1,
    "to": 1,
    "total": 1
  }
}

list of users available to be assigned as member

Returns all groups that the user has access to

get

Display a listing of the resource.

Authorizations

Query parameters

statusstring · enumoptional

ACTIVE or INACTIVE

Options: ACTIVE, INACTIVE

filterstringoptional

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

order_bystringoptional

Field to order results by

order_directionstring · enum · default: "asc"optional

Options: asc, desc

per_pageinteger · default: "10"optional

includestring · default: ""optional

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

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

{
  "data": [
    {
      "name": "text",
      "description": "text",
      "manager_id": 1,
      "status": "ACTIVE",
      "created_at": "2025-03-28T02:07:55.928Z",
      "updated_at": "2025-03-28T02:07:55.928Z",
      "id": "text"
    }
  ],
  "meta": {
    "filter": "text",
    "sort_by": "text",
    "sort_order": "asc",
    "count": 1,
    "total_pages": 1,
    "current_page": 1,
    "form": 1,
    "last_page": 1,
    "path": "text",
    "per_page": 1,
    "to": 1,
    "total": 1
  }
}

list of groups

Create or update a new setting

post

Create a new Settings css-override

Authorizations

Body

variablesstringoptional

sansSerifFontstringoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

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

201

{
  "key": "text",
  "config": [
    {}
  ],
  "name": "text",
  "helper": "text",
  "group": "text",
  "format": "text",
  "hidden": true,
  "readonly": true,
  "variables": "text",
  "sansSerifFont": "text",
  "id": "text",
  "created_at": "2025-03-28T02:07:55.928Z",
  "updated_at": "2025-03-28T02:07:55.928Z"
}

success

Save a new group

post

Store a newly created resource in storage.

Authorizations

Body

namestringoptional

Represents a group definition.

descriptionstringoptional

manager_idinteger · idoptional

statusstring · enumoptional

Options: ACTIVE, INACTIVE

Responses

application/json

cURL

JavaScript

Python

HTTP

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

201

422

{
  "name": "text",
  "description": "text",
  "manager_id": 1,
  "status": "ACTIVE",
  "created_at": "2025-03-28T02:07:55.928Z",
  "updated_at": "2025-03-28T02:07:55.928Z",
  "id": "text"
}

success

Update a group

put

Update a user

Authorizations

Path parameters

group_idintegerrequired

ID of group to return

Body

namestringoptional

Represents a group definition.

descriptionstringoptional

manager_idinteger · idoptional

statusstring · enumoptional

Options: ACTIVE, INACTIVE

Responses

application/json

cURL

JavaScript

Python

HTTP

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

204

404

No body

success

Save a new group member

post

Store a newly created resource in storage.

Authorizations

Body

group_idstring · idoptional

Represents a group Members definition.

member_idstring · idoptional

member_typestringoptional

descriptionstringoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

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

201

{
  "group_id": "text",
  "member_id": "text",
  "member_type": "text",
  "description": "text",
  "id": "text",
  "group": {},
  "member": {},
  "created_at": "2025-03-28T02:07:55.928Z",
  "updated_at": "2025-03-28T02:07:55.928Z"
}

success