processmaker.com Knowledge Center ProcessMaker University

Groups

API Reference for ProcessMaker Group API

PreviousUsers NextRequests

Last updated 5 months ago

Get single group by ID

get

Display the specified resource.

Authorizations

Path parameters

group_idintegerRequired

ID of group to return

Responses

200

Successfully found the group

application/json

Responseall of

404

Not Found

application/json

get

GET /api/1.0/groups/{group_id} HTTP/1.1
Host: 
Accept: */*

{
  "name": "text",
  "description": "text",
  "manager_id": 1,
  "status": "ACTIVE",
  "created_at": "2025-05-21T22:12:55.489Z",
  "updated_at": "2025-05-21T22:12:55.489Z",
  "id": "text"
}

Delete a group

delete

Delete a user

Authorizations

Path parameters

group_idintegerRequired

ID of group to return

Responses

204

success

404

Not Found

application/json

delete

DELETE /api/1.0/groups/{group_id} HTTP/1.1
Host: 
Accept: */*

No content

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 · enumOptionalDefault: ascPossible values:

per_pageintegerOptionalDefault: 10

Responses

200

list of members of a group

application/json

get

GET /api/1.0/groups/{group_id}/users HTTP/1.1
Host: 
Accept: */*

200

list of members of a group

{
  "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-05-21T22:12:55.489Z",
          "updated_at": "2025-05-21T22:12:55.489Z"
        }
      ],
      "birthdate": "2025-05-21",
      "delegation_user_id": "text",
      "manager_id": "text",
      "meta": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "force_change_password": true,
      "id": 1,
      "created_at": "2025-05-21T22:12:55.489Z",
      "updated_at": "2025-05-21T22:12:55.489Z",
      "deleted_at": "2025-05-21T22:12:55.489Z"
    }
  ],
  "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
  }
}

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 · enumOptionalDefault: ascPossible values:

per_pageintegerOptionalDefault: 10

Responses

200

list of members of a group

application/json

get

GET /api/1.0/groups/{group_id}/groups HTTP/1.1
Host: 
Accept: */*

200

list of members of a group

{
  "data": [
    {
      "name": "text",
      "description": "text",
      "manager_id": 1,
      "status": "ACTIVE",
      "created_at": "2025-05-21T22:12:55.489Z",
      "updated_at": "2025-05-21T22:12:55.489Z",
      "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
  }
}

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 · enumOptionalDefault: ascPossible values:

per_pageintegerOptionalDefault: 10

Responses

200

list of group_members

application/json

get

GET /api/1.0/group_members HTTP/1.1
Host: 
Accept: */*

200

list of group_members

{
  "data": [
    {
      "group_id": "text",
      "member_id": "text",
      "member_type": "text",
      "description": "text",
      "id": "text",
      "created_at": "2025-05-21T22:12:55.489Z",
      "updated_at": "2025-05-21T22:12:55.489Z"
    }
  ],
  "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
  }
}

Get single group member by ID

get

Display the specified resource.

Authorizations

Path parameters

group_member_idstringRequired

ID of group members to return

Responses

200

Successfully found the group members

application/json

Responseall of

get

GET /api/1.0/group_members/{group_member_id} HTTP/1.1
Host: 
Accept: */*

200

Successfully found the group members

{
  "group_id": "text",
  "member_id": "text",
  "member_type": "text",
  "id": "text",
  "created_at": "2025-05-21T22:12:55.489Z",
  "updated_at": "2025-05-21T22:12:55.489Z"
}

Delete a group member

delete

Delete a group membership

Authorizations

Path parameters

group_member_idstringRequired

ID of group_members to return

Responses

204

success

delete

DELETE /api/1.0/group_members/{group_member_id} HTTP/1.1
Host: 
Accept: */*

204

success

No content

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 · enumOptionalDefault: ascPossible values:

per_pageintegerOptionalDefault: 10

Responses

200

list of groups available to be assigned as member

application/json

get

GET /api/1.0/group_members_available HTTP/1.1
Host: 
Accept: */*

200

list of groups available to be assigned as member

{
  "data": [
    {
      "id": "text",
      "description": "text",
      "name": "text",
      "status": "ACTIVE",
      "created_at": "2025-05-21T22:12:55.489Z",
      "updated_at": "2025-05-21T22:12:55.489Z"
    }
  ],
  "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
  }
}

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 · enumOptionalDefault: ascPossible values:

per_pageintegerOptionalDefault: 10

Responses

200

list of users available to be assigned as member

application/json

get

GET /api/1.0/user_members_available HTTP/1.1
Host: 
Accept: */*

200

list of users available to be assigned as member

{
  "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-05-21T22:12:55.489Z",
          "updated_at": "2025-05-21T22:12:55.489Z"
        }
      ],
      "birthdate": "2025-05-21",
      "delegation_user_id": "text",
      "manager_id": "text",
      "meta": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "force_change_password": true,
      "id": 1,
      "created_at": "2025-05-21T22:12:55.489Z",
      "updated_at": "2025-05-21T22:12:55.489Z",
      "deleted_at": "2025-05-21T22:12:55.489Z"
    }
  ],
  "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
  }
}

Returns all groups that the user has access to

get

Display a listing of the resource.

Authorizations

Query parameters

statusstring · enumOptional

ACTIVE or INACTIVE

Possible values:

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 · enumOptionalDefault: ascPossible values:

per_pageintegerOptionalDefault: 10

includestringOptional

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

Default: ""

Responses

200

list of groups

application/json

get

GET /api/1.0/groups HTTP/1.1
Host: 
Accept: */*

200

list of groups

{
  "data": [
    {
      "name": "text",
      "description": "text",
      "manager_id": 1,
      "status": "ACTIVE",
      "created_at": "2025-05-21T22:12:55.489Z",
      "updated_at": "2025-05-21T22:12:55.489Z",
      "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
  }
}

Create or update a new setting

post

Create a new Settings css-override

Authorizations

Body

variablesstringOptional

sansSerifFontstringOptional

Responses

201

success

application/json

Responseall of

post

POST /api/1.0/customize-ui HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 43

{
  "variables": "text",
  "sansSerifFont": "text"
}

201

success

{
  "key": "text",
  "config": [
    {}
  ],
  "name": "text",
  "helper": "text",
  "group": "text",
  "format": "text",
  "hidden": true,
  "readonly": true,
  "variables": "text",
  "sansSerifFont": "text",
  "id": "text",
  "created_at": "2025-05-21T22:12:55.489Z",
  "updated_at": "2025-05-21T22:12:55.489Z"
}

Save a new group

post

Store a newly created resource in storage.

Authorizations

Body

namestringOptional

Represents a group definition.

descriptionstringOptional

manager_idinteger · idOptional

statusstring · enumOptionalPossible values:

Responses

201

success

application/json

Responseall of

422

Unprocessable Entity

application/json

post

POST /api/1.0/groups HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 69

{
  "name": "text",
  "description": "text",
  "manager_id": 1,
  "status": "ACTIVE"
}

{
  "name": "text",
  "description": "text",
  "manager_id": 1,
  "status": "ACTIVE",
  "created_at": "2025-05-21T22:12:55.489Z",
  "updated_at": "2025-05-21T22:12:55.489Z",
  "id": "text"
}

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 · enumOptionalPossible values:

Responses

204

success

404

Not Found

application/json

put

PUT /api/1.0/groups/{group_id} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 69

{
  "name": "text",
  "description": "text",
  "manager_id": 1,
  "status": "ACTIVE"
}

No content

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

201

success

application/json

Responseall of

post

POST /api/1.0/group_members HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 80

{
  "group_id": "text",
  "member_id": "text",
  "member_type": "text",
  "description": "text"
}

201

success

{
  "group_id": "text",
  "member_id": "text",
  "member_type": "text",
  "description": "text",
  "id": "text",
  "group": {},
  "member": {},
  "created_at": "2025-05-21T22:12:55.489Z",
  "updated_at": "2025-05-21T22:12:55.489Z"
}