API
User Documentation Installing ProcessMaker API Reference Guides

Users

API Reference for ProcessMaker Users API

Returns all users

Display a listing of the resource.

GET/api/1.0/users
Query parameters
Response

list of users

Body
dataarray of users (all of)
metametadata (object)
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": [
        {
          "model_type": "text",
          "collection_name": "text",
          "name": "text",
          "file_name": "text",
          "mime_type": "text",
          "disk": "text",
          "created_at": "2024-05-12T09:24:02.159Z",
          "updated_at": "2024-05-12T09:24:02.159Z"
        }
      ],
      "birthdate": "2024-05-12",
      "delegation_user_id": "text",
      "manager_id": "text",
      "force_change_password": false,
      "created_at": "2024-05-12T09:24:02.159Z",
      "updated_at": "2024-05-12T09:24:02.159Z",
      "deleted_at": "2024-05-12T09:24:02.159Z"
    }
  ],
  "meta": {
    "filter": "text",
    "sort_by": "text",
    "sort_order": "asc",
    "path": "text"
  }
}

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)
birthdatestring (date)
delegation_user_idstring (id)
manager_idstring (id)
metaobject
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)
birthdatestring (date)
delegation_user_idstring (id)
manager_idstring (id)
metaobject
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": [
    {
      "model_type": "text",
      "collection_name": "text",
      "name": "text",
      "file_name": "text",
      "mime_type": "text",
      "disk": "text",
      "created_at": "2024-05-12T09:24:02.159Z",
      "updated_at": "2024-05-12T09:24:02.159Z"
    }
  ],
  "birthdate": "2024-05-12",
  "delegation_user_id": "text",
  "manager_id": "text",
  "force_change_password": false,
  "created_at": "2024-05-12T09:24:02.159Z",
  "updated_at": "2024-05-12T09:24:02.159Z",
  "deleted_at": "2024-05-12T09:24:02.159Z"
}

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)
birthdatestring (date)
delegation_user_idstring (id)
manager_idstring (id)
metaobject
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": [
    {
      "model_type": "text",
      "collection_name": "text",
      "name": "text",
      "file_name": "text",
      "mime_type": "text",
      "disk": "text",
      "created_at": "2024-05-12T09:24:02.159Z",
      "updated_at": "2024-05-12T09:24:02.159Z"
    }
  ],
  "birthdate": "2024-05-12",
  "delegation_user_id": "text",
  "manager_id": "text",
  "force_change_password": false,
  "created_at": "2024-05-12T09:24:02.159Z",
  "updated_at": "2024-05-12T09:24:02.159Z",
  "deleted_at": "2024-05-12T09:24:02.159Z"
}

Update a user

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)
birthdatestring (date)
delegation_user_idstring (id)
manager_idstring (id)
metaobject
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();

Delete a user

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();

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
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();

Display listing of access tokens for the specified user.

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
Response

List of tokens.

Body
dataarray of UserToken (object)
metametadata (object)
Request
const response = await fetch('/api/1.0/users/{user_id}/tokens', {
    method: 'GET',
    headers: {},
});
const data = await response.json();
Response
{
  "data": [
    {
      "id": "text",
      "name": "text",
      "revoked": false,
      "client": {
        "name": "text",
        "provider": "text",
        "redirect": "text",
        "personal_access_client": false,
        "password_client": false,
        "revoked": false,
        "created_at": "2024-05-12T09:24:02.159Z",
        "updated_at": "2024-05-12T09:24:02.159Z"
      },
      "created_at": "2024-05-12T09:24:02.159Z",
      "updated_at": "2024-05-12T09:24:02.159Z",
      "expires_at": "2024-05-12T09:24:02.159Z"
    }
  ],
  "meta": {
    "filter": "text",
    "sort_by": "text",
    "sort_order": "asc",
    "path": "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)
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",
  "name": "text",
  "revoked": false,
  "client": {
    "name": "text",
    "provider": "text",
    "redirect": "text",
    "personal_access_client": false,
    "password_client": false,
    "revoked": false,
    "created_at": "2024-05-12T09:24:02.159Z",
    "updated_at": "2024-05-12T09:24:02.159Z"
  },
  "created_at": "2024-05-12T09:24:02.159Z",
  "updated_at": "2024-05-12T09:24:02.159Z",
  "expires_at": "2024-05-12T09:24:02.159Z"
}

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)
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",
  "name": "text",
  "revoked": false,
  "client": {
    "name": "text",
    "provider": "text",
    "redirect": "text",
    "personal_access_client": false,
    "password_client": false,
    "revoked": false,
    "created_at": "2024-05-12T09:24:02.159Z",
    "updated_at": "2024-05-12T09:24:02.159Z"
  },
  "created_at": "2024-05-12T09:24:02.159Z",
  "updated_at": "2024-05-12T09:24:02.159Z",
  "expires_at": "2024-05-12T09:24:02.159Z"
}

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();

Last updated