List users

get https://{xentralId}.xentral.biz/api/v1/users

Returns a collection with all users.

Responses

Response body

object

data

array of objects

required

A list of users

data*

object

string

required

Resource identifier.

globalUserId

string | null

Nullable UUID identifier of the resource.

username

string

required

The name of the user

createdAt

date-time

required

The date the user was created

description

string | null

required

color

string | null

An optional hex value without the #, representing the avatar color

isActive

boolean

A boolean value indicating if the user is active and can log in

locale

string

A ISO-639-1 formatted string indicating the language the user will use

isAdmin

boolean

A boolean value indicating if the user is an admin

string | null

emailVerifiedAt

date-time | null

The date where the user verified his email address

mfa

boolean | null

Auth Platform MFA state

extra

object

required

totalCount

integer

required

the total count of all items

page

object

required

The pagination object containing the current page number and size

403

Unable to authorize the client

406

Requested resource representation does not exist.

429

Too many API calls made.

Language

Credentials

Bearer

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://xentral.xentral.biz/api/v1/users \
3
     --header 'accept: application/json'


xxxxxxxxxx
24
 
1
{
2
  "data": [
3
    {
4
      "id": "12",
5
      "globalUserId": "f7b3b3b3-7b3b-4b3b-8b3b-3b3b3b3b3b3b",
6
      "username": "Bene",
7
      "createdAt": "2023-08-13T14:45:36+02:00",
8
      "description": "This is the user description.",
9
      "color": "ff0000",
10
      "isActive": true,
11
      "locale": "de_DE",
12
      "isAdmin": true,
13
      "email": "ceo@example.com",
14
      "emailVerifiedAt": "2023-08-14T14:45:36+02:00"
15
    }
16
  ],
17
  "extra": {
18
    "totalCount": 1,
19
    "page": {
20
      "number": 1,
21
      "size": 10
22
    }
23
  }
24
}

200Operation completed successfully.

401Unable to authenticate the client