Skip to Content
bpms.ai
ReferenceAccess

List the users

GET
/api/v1/access/users

Lists the BPMS 3.x users of the tenant of the request, paginated, as they are stored; deleted users are excluded and disabled users are listed.

Authorization

bearer
headerAuthorizationBearer <token>

The token of a session that createSession opened

Query Parameters

page?integer

Zero-based page index

Formatint32
Default0
size?integer

Page size, from 1; values above 100 are capped

Formatint32
Default20
sort?string

Sort field, userName or id; ties are ordered by id

Default"userName"

Response Body

A page of users

application/json
  1. response
items?array<>
page?integer
Formatint32
size?integer
Formatint32
totalElements?integer
Formatint64
totalPages?integer
Formatint32
Example Request
curl -X GET 'https://bpms.bpms.work/api/v1/access/users'
Example Response
{  "items": [    {      "email": "string",      "enabled": true,      "id": 0,      "identification": "string",      "lastName": "string",      "locked": true,      "name": "string",      "passwordChangeRequired": true,      "userName": "string"    }  ],  "page": 0,  "size": 0,  "totalElements": 0,  "totalPages": 0}