XExentral
User

List users V2

Changed on

Returns a collection with all users.

get/api/v2/users

Request

Query parameters

key'search' | 'id' | 'username' | 'description' | 'isActive' | 'isAdmin' | 'mfa' | 'email'
op'equals' | 'notEquals' | 'in' | 'notIn' | 'exactlyIn' | 'allIn' | 'allNotIn' | 'contains' | 'notContains' | 'startsWith' | 'endsWith' | 'greaterThan' | 'lessThan' | 'is' | 'lessThanOrEquals' | 'greaterThanOrEquals'
numberstring required

Page number should be an integer greater than or equal to 1

sizestring required

Page size should usually be an integer between 10 and 50.

field'id' | 'username' | 'isActive' | 'isAdmin' | 'mfa' | 'isSupportUser' | 'createdAt'
dir'asc' | 'desc'

Response

Operation completed successfully.

Example response

{
  "data": [
    {
      "id": "12",
      "globalUserId": "f7b3b3b3-7b3b-4b3b-8b3b-3b3b3b3b3b3b",
      "username": "Bene",
      "createdAt": "2023-08-13T14:45:36+02:00",
      "description": "This is the user description.",
      "color": "ff0000",
      "isActive": true,
      "locale": "de_DE",
      "isAdmin": true,
      "email": "ceo@example.com",
      "emailVerifiedAt": "2023-08-14T14:45:36+02:00",
      "contactId": "123",
      "isSupportUser": false
    }
  ],
  "extra": {
    "totalCount": 1,
    "page": {
      "number": 1,
      "size": 10
    }
  }
}

Changes

  • ebe5ba2a4ed8Revision changes
    • info

      added the enum value isSupportUser to the property items/field of the query request parameter order

    • info

      added the optional property // to the response with the status