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

application/json

variablesstring

sansSerifFontstring

Response

201

success

Body

application/json

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

JavaScriptCurlPython

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

201

{
  "key": "text",
  "config": [],
  "name": "text",
  "helper": "text",
  "group": "text",
  "format": "text",
  "hidden": false,
  "readonly": false,
  "variables": "text",
  "sansSerifFont": "text",
  "id": "text",
  "created_at": "2024-10-16T08:45:14.834Z",
  "updated_at": "2024-10-16T08:45:14.834Z"
}

Returns all groups that the user has access to

Display a listing of the resource.

GET/api/1.0/groups

Query parameters

Response

200

list of groups

Body

application/json

dataarray of groups (all of)

metametadata (object)

Request

JavaScriptCurlPython

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

Response

200

{
  "data": [
    {
      "name": "text",
      "description": "text",
      "status": "ACTIVE",
      "created_at": "2024-10-16T08:45:14.834Z",
      "updated_at": "2024-10-16T08:45:14.834Z",
      "id": "text"
    }
  ],
  "meta": {
    "filter": "text",
    "sort_by": "text",
    "sort_order": "asc",
    "path": "text"
  }
}

Save a new group

Store a newly created resource in storage.

POST/api/1.0/groups

Body

application/json

namestring

Represents a group definition.

descriptionstring

manager_idinteger (id)

statusenum

ACTIVEINACTIVE

Response

201422

success

Body

application/json

namestring

Represents a group definition.

descriptionstring

manager_idinteger (id)

statusenum

ACTIVEINACTIVE

created_atstring (date-time)

updated_atstring (date-time)

idstring (id)

Request

JavaScriptCurlPython

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

Response

201422

{
  "name": "text",
  "description": "text",
  "status": "ACTIVE",
  "created_at": "2024-10-16T08:45:14.834Z",
  "updated_at": "2024-10-16T08:45:14.834Z",
  "id": "text"
}

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

200404

Successfully found the group

Body

application/json

namestring

Represents a group definition.

descriptionstring

manager_idinteger (id)

statusenum

ACTIVEINACTIVE

created_atstring (date-time)

updated_atstring (date-time)

idstring (id)

Request

JavaScriptCurlPython

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

Response

200404

{
  "name": "text",
  "description": "text",
  "status": "ACTIVE",
  "created_at": "2024-10-16T08:45:14.834Z",
  "updated_at": "2024-10-16T08:45:14.834Z",
  "id": "text"
}

Update a group

Update a user

PUT/api/1.0/groups/{group_id}

Path parameters

group_id*integer

ID of group to return

Body

application/json

namestring

Represents a group definition.

descriptionstring

manager_idinteger (id)

statusenum

ACTIVEINACTIVE

Response

204404

success

Request

JavaScriptCurlPython

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

404

{
  "error": "text"
}

Delete a group

Delete a user

DELETE/api/1.0/groups/{group_id}

Path parameters

group_id*integer

ID of group to return

Response

204404

success

Request

JavaScriptCurlPython

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

Response

404

{
  "error": "text"
}

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

Response

200

list of members of a group

Body

application/json

dataarray of users (all of)

metametadata (object)

Request

JavaScriptCurlPython

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

Response

200

{
  "data": [
    {
      "email": "[e-mail]",
      "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": [
        {
          "model_type": "text",
          "collection_name": "text",
          "name": "text",
          "file_name": "text",
          "mime_type": "text",
          "disk": "text",
          "created_at": "2024-10-16T08:45:14.834Z",
          "updated_at": "2024-10-16T08:45:14.834Z"
        }
      ],
      "birthdate": "2024-10-16",
      "delegation_user_id": "text",
      "manager_id": "text",
      "force_change_password": false,
      "created_at": "2024-10-16T08:45:14.834Z",
      "updated_at": "2024-10-16T08:45:14.834Z",
      "deleted_at": "2024-10-16T08:45:14.834Z"
    }
  ],
  "meta": {
    "filter": "text",
    "sort_by": "text",
    "sort_order": "asc",
    "path": "text"
  }
}

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

Response

200

list of members of a group

Body

application/json

dataarray of groups (all of)

metametadata (object)

Request

JavaScriptCurlPython

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

Response

200

{
  "data": [
    {
      "name": "text",
      "description": "text",
      "status": "ACTIVE",
      "created_at": "2024-10-16T08:45:14.834Z",
      "updated_at": "2024-10-16T08:45:14.834Z",
      "id": "text"
    }
  ],
  "meta": {
    "filter": "text",
    "sort_by": "text",
    "sort_order": "asc",
    "path": "text"
  }
}

Returns all groups for a given member

Display a listing of the resource.

GET/api/1.0/group_members

Query parameters

Response

200

list of group_members

Body

application/json

dataarray of groupMembers (all of)

metametadata (object)

Request

JavaScriptCurlPython

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

Response

200

{
  "data": [
    {
      "group_id": "text",
      "member_id": "text",
      "member_type": "text",
      "description": "text",
      "id": "text",
      "created_at": "2024-10-16T08:45:14.834Z",
      "updated_at": "2024-10-16T08:45:14.834Z"
    }
  ],
  "meta": {
    "filter": "text",
    "sort_by": "text",
    "sort_order": "asc",
    "path": "text"
  }
}

Save a new group member

Store a newly created resource in storage.

POST/api/1.0/group_members

Body

application/json

group_idstring (id)

Represents a group Members definition.

member_idstring (id)

member_typestring

descriptionstring

Response

201

success

Body

application/json

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

JavaScriptCurlPython

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

201

{
  "group_id": "text",
  "member_id": "text",
  "member_type": "text",
  "description": "text",
  "id": "text",
  "created_at": "2024-10-16T08:45:14.834Z",
  "updated_at": "2024-10-16T08:45:14.834Z"
}

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

200

Successfully found the group members

Body

application/json

group_idstring (id)

member_idstring (id)

member_typestring

idstring (id)

created_atstring (date-time)

updated_atstring (date-time)

Request

JavaScriptCurlPython

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

Response

200

{
  "group_id": "text",
  "member_id": "text",
  "member_type": "text",
  "id": "text",
  "created_at": "2024-10-16T08:45:14.834Z",
  "updated_at": "2024-10-16T08:45:14.834Z"
}

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

204

success

Request

JavaScriptCurlPython

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

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

Response

200

list of groups available to be assigned as member

Body

application/json

dataarray of availableGroupMembers (all of)

metametadata (object)

Request

JavaScriptCurlPython

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

Response

200

{
  "data": [
    {
      "id": "text",
      "description": "text",
      "name": "text",
      "status": "ACTIVE",
      "created_at": "2024-10-16T08:45:14.834Z",
      "updated_at": "2024-10-16T08:45:14.834Z"
    }
  ],
  "meta": {
    "filter": "text",
    "sort_by": "text",
    "sort_order": "asc",
    "path": "text"
  }
}

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

Response

200

list of users available to be assigned as member

Body

application/json

dataarray of users (all of)

metametadata (object)

Request

JavaScriptCurlPython

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

Response

200

{
  "data": [
    {
      "email": "[e-mail]",
      "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": [
        {
          "model_type": "text",
          "collection_name": "text",
          "name": "text",
          "file_name": "text",
          "mime_type": "text",
          "disk": "text",
          "created_at": "2024-10-16T08:45:14.834Z",
          "updated_at": "2024-10-16T08:45:14.834Z"
        }
      ],
      "birthdate": "2024-10-16",
      "delegation_user_id": "text",
      "manager_id": "text",
      "force_change_password": false,
      "created_at": "2024-10-16T08:45:14.834Z",
      "updated_at": "2024-10-16T08:45:14.834Z",
      "deleted_at": "2024-10-16T08:45:14.834Z"
    }
  ],
  "meta": {
    "filter": "text",
    "sort_by": "text",
    "sort_order": "asc",
    "path": "text"
  }
}