List Users (REST)
GET <baseurl>/api/v1/users
This lists the users as API equivalent of disp = users.
Parameters
Name |
Type |
Description |
Default |
---|---|---|---|
paged |
integer |
Page number |
1 |
page |
integer |
Page number, when |
1 |
per_page |
integer |
Count users per page |
10 |
filter |
string |
How to update the users list:
|
|
restrict_to_available_fileroots |
integer |
Additional restriction of collections for current user |
0 |
gender_men |
integer |
|
0 |
gender_women |
integer |
|
0 |
keywords |
string |
Find the requested keywords in the user fields |
|
q |
string |
This is alias for the param |
|
country |
integer |
Country ID |
|
region |
integer |
Region ID |
|
subregion |
integer |
Sub-region ID |
|
city |
integer |
City ID |
|
age_min |
integer |
Minimum age |
|
age_max |
integer |
Maximum age |
|
level_min |
integer |
Minimum user level |
|
level_max |
integer |
Maximum user level |
|
org |
integer |
Organization ID |
|
criteria_type%5B%5D |
array |
Specific criteria user field ID. |
|
criteria_value%5B%5D |
array |
Specific criteria user field keyword. |
Response
Name |
Type |
Description |
||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
found |
integer |
Number of found users |
||||||||||||||||||
page |
integer |
Current page |
||||||||||||||||||
page_size |
integer |
Number users per page |
||||||||||||||||||
pages_total |
integer |
Number of total pages |
||||||||||||||||||
users |
array |
Array of users:
|
Errors
Error code |
HTTP response |
Message |
---|---|---|
unknown_controller |
404 |
Unknown user controller "<user_controller>" |
no_access |
403 |
You must log in to view the user directory. |
no_access |
403 |
You must activate your account before you can view the user directory. |
no_access |
403 |
Your account status currently does not permit to view the user directory. |
no_access |
403 |
Please specify your country before attempting to contact other users.. |
no_users |
404 |
No users found |
Used for:
- Search users in modal window of file browser menu option "User roots -> Other…" in order to switch a selected user File Root