processmaker.com Knowledge Center ProcessMaker University

Users

API Reference for ProcessMaker Users API

PreviousProcessMaker Platform RESTful API NextGroups

Last updated 2 months ago

Was this helpful?

Returns all users

Display a listing of the resource.

get

/users

Authorizations

Query parameters

statusstring · enum

ACTIVE or INACTIVE

Options: ACTIVE, INACTIVE

filterstring

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

order_bystring

Field to order results by

order_directionstring · enum · default: asc

Options: asc, desc

per_pageinteger · default: 10

includestring

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

exclude_idsstring

Comma separated list of IDs to exclude from the response

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

{
  "meta": {
    "filter": "text",
    "sort_by": "text",
    "count": 1,
    "total_pages": 1,
    "current_page": 1,
    "form": 1,
    "last_page": 1,
    "path": "text",
    "per_page": 1,
    "to": 1,
    "total": 1,
    "sort_order": "asc"
  },
  "data": [
    {
      "email": "hello@example.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",
      "fullname": "text",
      "avatar": "text",
      "birthdate": "2025-02-20",
      "delegation_user_id": "text",
      "manager_id": "text",
      "meta": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "force_change_password": true,
      "status": "ACTIVE",
      "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-02-20T18:23:32.278Z",
          "updated_at": "2025-02-20T18:23:32.278Z"
        }
      ],
      "id": 1,
      "created_at": "2025-02-20T18:23:32.278Z",
      "updated_at": "2025-02-20T18:23:32.278Z",
      "deleted_at": "2025-02-20T18:23:32.278Z"
    }
  ]
}

list of users

Save a new users

Store a newly created resource in storage.

post

/users

Authorizations

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

fullnamestring

avatarstring

birthdatestring · date

delegation_user_idstring · id

manager_idstring · id

metaobject

force_change_passwordboolean

statusstring · enum

Options: ACTIVE, INACTIVE, SCHEDULED, OUT_OF_OFFICE

mediaobject[]

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/1.0/users' \
  --header 'Content-Type: application/json' \
  --data '{"meta":{"ANY_ADDITIONAL_PROPERTY":"anything"},"status":"ACTIVE","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-02-20T18:23:32.278Z","updated_at":"2025-02-20T18:23:32.278Z"}]}'

201

422

{
  "email": "hello@example.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",
  "fullname": "text",
  "avatar": "text",
  "birthdate": "2025-02-20",
  "delegation_user_id": "text",
  "manager_id": "text",
  "meta": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "force_change_password": true,
  "status": "ACTIVE",
  "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-02-20T18:23:32.278Z",
      "updated_at": "2025-02-20T18:23:32.278Z"
    }
  ],
  "id": 1,
  "created_at": "2025-02-20T18:23:32.278Z",
  "updated_at": "2025-02-20T18:23:32.278Z",
  "deleted_at": "2025-02-20T18:23:32.278Z"
}

success

Get single user by ID

Display the specified resource.

get

/users/{user_id}

Authorizations

Path parameters

user_idintegerrequired

ID of user to return

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

404

{
  "email": "hello@example.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",
  "fullname": "text",
  "avatar": "text",
  "birthdate": "2025-02-20",
  "delegation_user_id": "text",
  "manager_id": "text",
  "meta": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "force_change_password": true,
  "status": "ACTIVE",
  "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-02-20T18:23:32.278Z",
      "updated_at": "2025-02-20T18:23:32.278Z"
    }
  ],
  "id": 1,
  "created_at": "2025-02-20T18:23:32.278Z",
  "updated_at": "2025-02-20T18:23:32.278Z",
  "deleted_at": "2025-02-20T18:23:32.278Z"
}

Successfully found the process

Update a user

put

/users/{user_id}

Authorizations

Path parameters

user_idintegerrequired

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

fullnamestring

avatarstring

birthdatestring · date

delegation_user_idstring · id

manager_idstring · id

metaobject

force_change_passwordboolean

statusstring · enum

Options: ACTIVE, INACTIVE, SCHEDULED, OUT_OF_OFFICE

mediaobject[]

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/api/1.0/users/{user_id}' \
  --header 'Content-Type: application/json' \
  --data '{"meta":{"ANY_ADDITIONAL_PROPERTY":"anything"},"status":"ACTIVE","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-02-20T18:23:32.278Z","updated_at":"2025-02-20T18:23:32.278Z"}]}'

204

404

422

No body

success

Delete a user

delete

/users/{user_id}

Authorizations

Path parameters

user_idintegerrequired

ID of user to delete

Responses

application/json

cURL

JavaScript

Python

HTTP

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

204

404

No body

success

Set the groups a users belongs to

Update a user's groups

put

/users/{user_id}/groups

Authorizations

Path parameters

user_idintegerrequired

ID of user

Body

groupsinteger[]

Responses

cURL

JavaScript

Python

HTTP

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

204

No body

success

Restore a soft deleted user

Reverses the soft delete of a user

put

/users/restore

Authorizations

Body

usernamestring

Username to restore

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/api/1.0/users/restore' \
  --header 'Content-Type: application/json'

200

No body

success

Display listing of access tokens for the specified user.

get

/users/{user_id}/tokens

Authorizations

Path parameters

user_idintegerrequired

User id

Query parameters

per_pageinteger · default: 10

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

{
  "meta": {
    "filter": "text",
    "sort_by": "text",
    "count": 1,
    "total_pages": 1,
    "current_page": 1,
    "form": 1,
    "last_page": 1,
    "path": "text",
    "per_page": 1,
    "to": 1,
    "total": 1,
    "sort_order": "asc"
  },
  "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-02-20T18:23:32.278Z",
        "updated_at": "2025-02-20T18:23:32.278Z"
      },
      "created_at": "2025-02-20T18:23:32.278Z",
      "updated_at": "2025-02-20T18:23:32.278Z",
      "expires_at": "2025-02-20T18:23:32.278Z"
    }
  ]
}

List of tokens.

Create new token for a specific user

Create a new personal access token for the user.

post

/users/{user_id}/tokens

Authorizations

Path parameters

user_idintegerrequired

User id

Body

namestring

Responses

application/json

cURL

JavaScript

Python

HTTP

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

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-02-20T18:23:32.278Z",
    "updated_at": "2025-02-20T18:23:32.278Z"
  },
  "created_at": "2025-02-20T18:23:32.278Z",
  "updated_at": "2025-02-20T18:23:32.278Z",
  "expires_at": "2025-02-20T18:23:32.278Z"
}

New token instance

Get single token by ID

Show a personal access token for the user

get

/users/{user_id}/tokens/{token_id}

Authorizations

Path parameters

user_idintegerrequired

ID of user

token_idstringrequired

ID of token to return

Responses

application/json

cURL

JavaScript

Python

HTTP

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

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-02-20T18:23:32.278Z",
    "updated_at": "2025-02-20T18:23:32.278Z"
  },
  "created_at": "2025-02-20T18:23:32.278Z",
  "updated_at": "2025-02-20T18:23:32.278Z",
  "expires_at": "2025-02-20T18:23:32.278Z"
}

Successfully found the token

Delete a token

Delete the given token for a user

delete

/users/{user_id}/tokens/{token_id}

Authorizations

Path parameters

user_idintegerrequired

User ID

token_idstringrequired

Token ID

Responses

cURL

JavaScript

Python

HTTP

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

204

No body

success