Access Control - Users

UsersController_findAll

GET

/access-control/users

const url = 'https://api.inspow.tech/api/v1/access-control/users?limit=10&offset=0&sortBy=createdAt&sortOrder=asc&sort=%7B%22lastName%22%3A%20-1%2C%20%22email%22%3A%201%7D';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://api.inspow.tech/api/v1/access-control/users?limit=10&offset=0&sortBy=createdAt&sortOrder=asc&sort=%7B%22lastName%22%3A%20-1%2C%20%22email%22%3A%201%7D'

Parameters

Query Parameters

limit

required

number

Example

Number of items to return

offset

required

number

Example

Number of items to skip

sortBy

string

Example

createdAt

Field to sort the results (Deprecated, use sort instead)

sortOrder

string

Example

asc

Sort direction, either asc or desc (Deprecated, use sort instead)

searchQuery

string

Query search to filter items

query

string

Query to filter items in MongoDB query format

sort

string

Example

{"lastName": -1, "email": 1}

JSON string specifying sorting fields and order (e.g. { “lastName”: -1, “email”: 1 })

Responses

200

application/json

object

email

required

The email address of the user.

string format: email

firstName

required

The first name of the user.

string

>= 1 characters

lastName

The last name of the user.

string

>= 1 characters

roles

An array of role IDs assigned to the user.

Array<string>

updatedAt

required

The timestamp when the attendance record was last updated.

string format: date-time

Example

{
  "email": "test_email@inspow.com",
  "firstName": "John",
  "lastName": "John",
  "roles": [
    "645cc3d3f8a9c9a2b88a22c1",
    "645cc3d3f8a9c9a2b88a22c2"
  ],
  "updatedAt": "2023-11-26T00:00:00.000Z"
}