Groups
API Reference for ProcessMaker Group API
Create a new Settings css-override
POST /api/1.0/customize-ui HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 43
{
"variables": "text",
"sansSerifFont": "text"
}
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-07-02T02:47:39.778Z",
"updated_at": "2025-07-02T02:47:39.778Z"
}
Display a listing of the resource.
ACTIVE or INACTIVE
Filter results by string. Searches Name, Description, and Status. Status must match exactly. Others can be a substring.
Field to order results by
asc
Possible values: 10
Include data from related models in payload. Comma separated list.
""
GET /api/1.0/groups HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
list of groups
{
"data": [
{
"name": "text",
"description": "text",
"manager_id": 1,
"status": "ACTIVE",
"created_at": "2025-07-02T02:47:39.778Z",
"updated_at": "2025-07-02T02:47:39.778Z",
"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
}
}
Store a newly created resource in storage.
Represents a group definition.
POST /api/1.0/groups HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
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-07-02T02:47:39.778Z",
"updated_at": "2025-07-02T02:47:39.778Z",
"id": "text"
}
Display the specified resource.
ID of group to return
GET /api/1.0/groups/{group_id} HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
"name": "text",
"description": "text",
"manager_id": 1,
"status": "ACTIVE",
"created_at": "2025-07-02T02:47:39.778Z",
"updated_at": "2025-07-02T02:47:39.778Z",
"id": "text"
}
Update a user
ID of group to return
Represents a group definition.
PUT /api/1.0/groups/{group_id} HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 69
{
"name": "text",
"description": "text",
"manager_id": 1,
"status": "ACTIVE"
}
No content
Display the list of users in a group
ID of group
Filter results by string. Searches Name, Description, and Status. Status must match exactly. Others can be a substring.
asc
Possible values: 10
GET /api/1.0/groups/{group_id}/users HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
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-07-02T02:47:39.778Z",
"updated_at": "2025-07-02T02:47:39.778Z"
}
],
"birthdate": "2025-07-02",
"delegation_user_id": "text",
"manager_id": "text",
"meta": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"force_change_password": true,
"id": 1,
"created_at": "2025-07-02T02:47:39.778Z",
"updated_at": "2025-07-02T02:47:39.778Z",
"deleted_at": "2025-07-02T02:47:39.778Z"
}
],
"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
}
}
Display the list of groups in a group
ID of group
Filter results by string. Searches Name, Description, and Status. Status must match exactly. Others can be a substring.
asc
Possible values: 10
GET /api/1.0/groups/{group_id}/groups HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
list of members of a group
{
"data": [
{
"name": "text",
"description": "text",
"manager_id": 1,
"status": "ACTIVE",
"created_at": "2025-07-02T02:47:39.778Z",
"updated_at": "2025-07-02T02:47:39.778Z",
"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
}
}
Display a listing of the resource.
Field to order results by
asc
Possible values: 10
GET /api/1.0/group_members HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
list of group_members
{
"data": [
{
"group_id": "text",
"member_id": "text",
"member_type": "text",
"description": "text",
"id": "text",
"created_at": "2025-07-02T02:47:39.778Z",
"updated_at": "2025-07-02T02:47:39.778Z"
}
],
"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
}
}
Store a newly created resource in storage.
Represents a group Members definition.
POST /api/1.0/group_members HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 80
{
"group_id": "text",
"member_id": "text",
"member_type": "text",
"description": "text"
}
success
{
"group_id": "text",
"member_id": "text",
"member_type": "text",
"description": "text",
"id": "text",
"group": {},
"member": {},
"created_at": "2025-07-02T02:47:39.778Z",
"updated_at": "2025-07-02T02:47:39.778Z"
}
Display the specified resource.
ID of group members to return
GET /api/1.0/group_members/{group_member_id} HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
Successfully found the group members
{
"group_id": "text",
"member_id": "text",
"member_type": "text",
"id": "text",
"created_at": "2025-07-02T02:47:39.778Z",
"updated_at": "2025-07-02T02:47:39.778Z"
}
Display a listing of groups available
ID of group member to return
type of group member to return
Filter results by string. Searches Name, Description, and Status. Status must match exactly. Others can be a substring.
Field to order results by
asc
Possible values: 10
GET /api/1.0/group_members_available HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
list of groups available to be assigned as member
{
"data": [
{
"id": "text",
"description": "text",
"name": "text",
"status": "ACTIVE",
"created_at": "2025-07-02T02:47:39.778Z",
"updated_at": "2025-07-02T02:47:39.778Z"
}
],
"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
}
}
Display a listing of users available
ID of group to return
Filter results by string. Searches Name. Can be a substring.
Field to order results by
asc
Possible values: 10
GET /api/1.0/user_members_available HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
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-07-02T02:47:39.778Z",
"updated_at": "2025-07-02T02:47:39.778Z"
}
],
"birthdate": "2025-07-02",
"delegation_user_id": "text",
"manager_id": "text",
"meta": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"force_change_password": true,
"id": 1,
"created_at": "2025-07-02T02:47:39.778Z",
"updated_at": "2025-07-02T02:47:39.778Z",
"deleted_at": "2025-07-02T02:47:39.778Z"
}
],
"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
}
}
Last updated