Vai al contenuto principale
GET
/
api
/
v1
/
settings
/
users
List users
curl --request GET \
  --url https://app.aegister.com/api/v1/settings/users \
  --header 'X-Aegister-Token: <api-key>'
{
  "error": 0,
  "messages": "<array>",
  "total": 1,
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "email": "<string>",
      "username": "<string>",
      "first_name": "<string>",
      "last_name": "<string>",
      "picture": "<string>",
      "is_active": true,
      "groups": [
        "<string>"
      ],
      "timestamp_joined": 123,
      "roles": {}
    }
  ]
}

Autorizzazioni

​
X-Aegister-Token
string
header
obbligatorio

Parametri della query

​
limit
number
predefinito:50

Max number of response items.

​
offset
number
predefinito:0

Offset response items.

​
order
string
predefinito:username

Order results by user field.

​
role
string

Filter by user role.

​
text
string

Filter by first name, last name, or email (case insensitive).

​
username
string

Filter by exact email address.

Risposta

​
error
integer

Any value different from 0 indicates an error.
More details can be found in messages.

Intervallo richiesto: 0 <= x <= 0
Esempio:

0

​
messages
array

If error is 1, contains zero or more details on the error.

Esempio:
[]
​
total
number

Total number of items that meet the list filter.
This doesn't represent the number of items inside the data array.

Intervallo richiesto: x >= 0
Esempi:

20

30

40

​
data
object[]