Users

API Reference for ProcessMaker Users API

Returns all users

get

Display a listing of the resource.

Authorizations

passportbearer

Query parameters

statusstring · enumoptional

ACTIVE or INACTIVE

Options: ACTIVE, INACTIVE

filterstringoptional

Filter results by string. Searches First Name, Last Name, Email and Username.

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.

exclude_idsstring · default: ""optional

Comma separated list of IDs to exclude from the response

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

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": 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-22T01:33:17.642Z",
          "updated_at": "2025-03-22T01:33:17.642Z"
        }
      ],
      "birthdate": "2025-03-22",
      "delegation_user_id": "text",
      "manager_id": "text",
      "meta": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "force_change_password": true,
      "id": 1,
      "created_at": "2025-03-22T01:33:17.642Z",
      "updated_at": "2025-03-22T01:33:17.642Z",
      "deleted_at": "2025-03-22T01:33:17.642Z"
    }
  ],
  "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

Save a new users

post

Store a newly created resource in storage.

Authorizations

passportbearer

Body

emailstring · emailoptional

The attributes that are mass assignable.

firstnamestringoptional

lastnamestringoptional

usernamestringoptional

passwordstringoptional

addressstringoptional

citystringoptional

statestringoptional

postalstringoptional

countrystringoptional

phonestringoptional

faxstringoptional

cellstringoptional

titlestringoptional

timezonestringoptional

datetime_formatstringoptional

languagestringoptional

is_administratorbooleanoptional

expires_atstringoptional

loggedin_atstringoptional

remember_tokenstringoptional

statusstring · enumoptional

Options: ACTIVE, INACTIVE, SCHEDULED, OUT_OF_OFFICE

fullnamestringoptional

avatarstringoptional

mediaall of[]optional

birthdatestring · dateoptional

delegation_user_idstring · idoptional

manager_idstring · idoptional

metaobjectoptional

force_change_passwordbooleanoptional

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/1.0/users' \
  --header 'Content-Type: application/json' \
  --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": 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-22T01:33:17.642Z",
        "updated_at": "2025-03-22T01:33:17.642Z"
      }
    ],
    "birthdate": "2025-03-22",
    "delegation_user_id": "text",
    "manager_id": "text",
    "meta": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "force_change_password": true
  }'

application/json

201

422

201

{
  "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": 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-22T01:33:17.642Z",
      "updated_at": "2025-03-22T01:33:17.642Z"
    }
  ],
  "birthdate": "2025-03-22",
  "delegation_user_id": "text",
  "manager_id": "text",
  "meta": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "force_change_password": true,
  "id": 1,
  "created_at": "2025-03-22T01:33:17.642Z",
  "updated_at": "2025-03-22T01:33:17.642Z",
  "deleted_at": "2025-03-22T01:33:17.642Z"
}

success

Get single user by ID

get

Display the specified resource.

Authorizations

passportbearer

Path parameters

user_idintegerrequired

ID of user to return

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

404

200

{
  "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": 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-22T01:33:17.642Z",
      "updated_at": "2025-03-22T01:33:17.642Z"
    }
  ],
  "birthdate": "2025-03-22",
  "delegation_user_id": "text",
  "manager_id": "text",
  "meta": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "force_change_password": true,
  "id": 1,
  "created_at": "2025-03-22T01:33:17.642Z",
  "updated_at": "2025-03-22T01:33:17.642Z",
  "deleted_at": "2025-03-22T01:33:17.642Z"
}

Successfully found the process

Update a user

put

Update a user

Authorizations

passportbearer

Path parameters

user_idintegerrequired

ID of user to return

Body

emailstring · emailoptional

The attributes that are mass assignable.

firstnamestringoptional

lastnamestringoptional

usernamestringoptional

passwordstringoptional

addressstringoptional

citystringoptional

statestringoptional

postalstringoptional

countrystringoptional

phonestringoptional

faxstringoptional

cellstringoptional

titlestringoptional

timezonestringoptional

datetime_formatstringoptional

languagestringoptional

is_administratorbooleanoptional

expires_atstringoptional

loggedin_atstringoptional

remember_tokenstringoptional

statusstring · enumoptional

Options: ACTIVE, INACTIVE, SCHEDULED, OUT_OF_OFFICE

fullnamestringoptional

avatarstringoptional

mediaall of[]optional

birthdatestring · dateoptional

delegation_user_idstring · idoptional

manager_idstring · idoptional

metaobjectoptional

force_change_passwordbooleanoptional

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/api/1.0/users/{user_id}' \
  --header 'Content-Type: application/json' \
  --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": 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-22T01:33:17.642Z",
        "updated_at": "2025-03-22T01:33:17.642Z"
      }
    ],
    "birthdate": "2025-03-22",
    "delegation_user_id": "text",
    "manager_id": "text",
    "meta": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "force_change_password": true
  }'

application/json

204

404

422

204

No body

success

Delete a user

delete

Delete a user

Authorizations

passportbearer

Path parameters

user_idintegerrequired

ID of user to delete

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/api/1.0/users/{user_id}'

204

404

204

No body

success

Set the groups a users belongs to

put

Update a user's groups

Authorizations

passportbearer

Path parameters

user_idintegerrequired

ID of user

Body

groupsinteger[]optional

Example: 1

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/api/1.0/users/{user_id}/groups' \
  --header 'Content-Type: application/json' \
  --data '{
    "groups": [
      1
    ]
  }'

application/json

204

204

No body

success

Restore a soft deleted user

put

Reverses the soft delete of a user

Authorizations

passportbearer

Body

usernamestringoptional

Username to restore

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/api/1.0/users/restore' \
  --header 'Content-Type: application/json' \
  --data '{
    "username": "text"
  }'

application/json

200

200

No body

success

Display listing of access tokens for the specified user.

get

Display listing of access tokens for the specified user.

Authorizations

passportbearer

Path parameters

user_idintegerrequired

User id

Query parameters

per_pageinteger · default: "10"optional

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/1.0/users/{user_id}/tokens'

200

200

{
  "data": [
    {
      "id": "text",
      "user_id": 1,
      "client_id": 1,
      "name": "text",
      "scopes": {},
      "revoked": true,
      "client": {
        "id": 1,
        "user_id": 1,
        "name": "text",
        "provider": "text",
        "redirect": "text",
        "personal_access_client": true,
        "password_client": true,
        "revoked": true,
        "created_at": "2025-03-22T01:33:17.642Z",
        "updated_at": "2025-03-22T01:33:17.642Z"
      },
      "created_at": "2025-03-22T01:33:17.642Z",
      "updated_at": "2025-03-22T01:33:17.642Z",
      "expires_at": "2025-03-22T01:33:17.642Z"
    }
  ],
  "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 tokens.

Create new token for a specific user

post

Create a new personal access token for the user.

Authorizations

passportbearer

Path parameters

user_idintegerrequired

User id

Body

namestringoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/1.0/users/{user_id}/tokens' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text"
  }'

application/json

201

201

{
  "id": "text",
  "user_id": 1,
  "client_id": 1,
  "name": "text",
  "scopes": {},
  "revoked": true,
  "client": {
    "id": 1,
    "user_id": 1,
    "name": "text",
    "provider": "text",
    "redirect": "text",
    "personal_access_client": true,
    "password_client": true,
    "revoked": true,
    "created_at": "2025-03-22T01:33:17.642Z",
    "updated_at": "2025-03-22T01:33:17.642Z"
  },
  "created_at": "2025-03-22T01:33:17.642Z",
  "updated_at": "2025-03-22T01:33:17.642Z",
  "expires_at": "2025-03-22T01:33:17.642Z"
}

New token instance

Get single token by ID

get

Show a personal access token for the user

Authorizations

passportbearer

Path parameters

user_idintegerrequired

ID of user

token_idstringrequired

ID of token to return

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/1.0/users/{user_id}/tokens/{token_id}'

200

200

{
  "id": "text",
  "user_id": 1,
  "client_id": 1,
  "name": "text",
  "scopes": {},
  "revoked": true,
  "client": {
    "id": 1,
    "user_id": 1,
    "name": "text",
    "provider": "text",
    "redirect": "text",
    "personal_access_client": true,
    "password_client": true,
    "revoked": true,
    "created_at": "2025-03-22T01:33:17.642Z",
    "updated_at": "2025-03-22T01:33:17.642Z"
  },
  "created_at": "2025-03-22T01:33:17.642Z",
  "updated_at": "2025-03-22T01:33:17.642Z",
  "expires_at": "2025-03-22T01:33:17.642Z"
}

Successfully found the token

Delete a token

delete

Delete the given token for a user

Authorizations

passportbearer

Path parameters

user_idintegerrequired

User ID

token_idstringrequired

Token ID

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/api/1.0/users/{user_id}/tokens/{token_id}'

204

204

No body

success