v1

latestOpenAPI 3.0.02026-07-2455104.8 MB

User

List users

Returns a collection with all users.

get/api/v1/users

Query parameters

idsstring[]

usernamestring

descriptionstring

colorstring

isActiveboolean

emailstring

V1 filter format (used with application/json Accept header)

{
  "ids": [
    "17"
  ]
}

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' | '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"
    }
  ],
  "extra": {
    "totalCount": 1,
    "page": {
      "number": 1,
      "size": 10
    }
  }
}