iotoms Docs

List users

GET
/api/v1/management/users

Returns back-office users that have not been deleted (both active and inactive status), sorted by first name, paginated with 0-based page and size 1 to 100 (default 20). query matches part of the username, first name, last name or email.

Authorization

BearerAuth
headerAuthorizationBearer <JWT>

Query Parameters

query?string

Optional text matched (case-insensitive, partial) against username, first name, last name and email.

page?integer

Page number, starting at 0. See Paging.

Formatint32
Default0
size?integer

Number of records per page.

Formatint32
Default20

Header Parameters

Response Body

OK

*/*
  1. response
status*string

Outcome of the call: SUCCESS when the request worked, ERROR when it did not.

message*string

Short human-readable message describing the result, for logs or display; do not parse it.

data?

One page of users, sorted by first name, with paging details.

Example Request
curl -X GET 'https://beta.iotoms.com/api/v1/management/users'
Example Response
{  "status": "string",  "message": "string",  "data": {    "content": [      {        "userId": 0,        "username": "string",        "roleId": 0,        "enablePin": true,        "firstName": "string",        "lastName": "string",        "email": "string",        "passwordUpdatedOn": "2019-08-24T14:15:22Z",        "createdAt": "2019-08-24T14:15:22Z",        "updatedAt": "2019-08-24T14:15:22Z",        "status": "string"      }    ],    "page": 0,    "size": 0,    "totalElements": 0,    "totalPages": 0,    "last": true  }}