User List Resource¶
Provides information on registered users.
If a user’s profile is private, the fields email
, first_name
,
last_name
, and fullname
will be omitted for non-staff users.
Details¶
Name | users |
URI | /api/users/ |
HTTP Methods |
|
Parent Resource | Root List Resource |
Child Resources | |
Anonymous Access | Yes, if anonymous site access is enabled |
Links¶
Name | Method | Resource |
---|---|---|
self | GET | User List Resource |
HTTP GET¶
Retrieves the list of users on the site.
This includes only the users who have active accounts on the site. Any account that has been disabled (for inactivity, spam reasons, or anything else) will be excluded from the list.
The list of users can be filtered down using the q
and
fullname
parameters.
Setting q
to a value will by default limit the results to
usernames starting with that value. This is a case-insensitive
comparison.
If fullname
is set to 1
, the first and last names will also be
checked along with the username. fullname
is ignored if q
is not set.
For example, accessing /api/users/?q=bo&fullname=1
will list
any users with a username, first name or last name starting with
bo
.
Request Parameters¶
counts-onlyBoolean | If specified, a single count field is returned with the number of results, instead of the results themselves. |
fullnameBoolean | Specifies whether q should also match the beginning of the first name or last name. Ignored if q is not set. |
include-inactiveBoolean | If set, users who are marked as inactive (their accounts have been disabled) will be included in the list. |
max-resultsInteger | The maximum number of results to return in this list. By default, this is 25. There is a hard limit of 200; if you need more than 200 results, you will need to make more than one request, using the “next” pagination link. |
qString | The string that the username (or the first name or last name when using fullname ) must start with in order to be included in the list. This is case-insensitive. |
startInteger | The 0-based index of the first result in the list. The start index is usually the previous start index plus the number of previous results. By default, this is 0. |
Errors¶
100 - Does Not ExistHTTP 404 - Not Found | Object does not exist |
101 - Permission DeniedHTTP 403 - Forbidden | You don’t have permission for this |
103 - Not Logged InHTTP 401 - Unauthorized | You are not logged in |
105 - Invalid Form DataHTTP 400 - Bad Request | One or more fields had errors |
226 - User Query ErrorHTTP 500 - Internal Server Error | An error occurred querying the user list. |
Examples¶
application/vnd.reviewboard.org.users+json¶
$ curl http://reviews.example.com/api/users/ -H "Accept: application/json"
Vary: Accept, Cookie
Item-Content-Type: application/vnd.reviewboard.org.user+json
Content-Type: application/vnd.reviewboard.org.users+json
X-Content-Type-Options: nosniff
{
"links": {
"self": {
"href": "http://reviews.example.com/api/users/",
"method": "GET"
}
},
"stat": "ok",
"total_results": 4,
"users": [
{
"avatar_url": "http://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61",
"email": "admin@example.com",
"first_name": "Admin",
"fullname": "Admin User",
"id": 1,
"last_name": "User",
"links": {
"self": {
"href": "http://reviews.example.com/api/users/admin/",
"method": "GET"
},
"watched": {
"href": "http://reviews.example.com/api/users/admin/watched/",
"method": "GET"
}
},
"url": "/users/admin/",
"username": "admin"
},
{
"avatar_url": "http://www.gravatar.com/avatar/b0f1ae4342591db2695fb11313114b3e",
"email": "doc@example.com",
"first_name": "Doc",
"fullname": "Doc Dwarf",
"id": 2,
"last_name": "Dwarf",
"links": {
"self": {
"href": "http://reviews.example.com/api/users/doc/",
"method": "GET"
},
"watched": {
"href": "http://reviews.example.com/api/users/doc/watched/",
"method": "GET"
}
},
"url": "/users/doc/",
"username": "doc"
},
{
"avatar_url": "http://www.gravatar.com/avatar/1a0098e6600792ea4f714aa205bf3f2b",
"email": "dopey@example.com",
"first_name": "Dopey",
"fullname": "Dopey Dwarf",
"id": 3,
"last_name": "Dwarf",
"links": {
"self": {
"href": "http://reviews.example.com/api/users/dopey/",
"method": "GET"
},
"watched": {
"href": "http://reviews.example.com/api/users/dopey/watched/",
"method": "GET"
}
},
"url": "/users/dopey/",
"username": "dopey"
},
{
"avatar_url": "http://www.gravatar.com/avatar/8f32aaaba6ce2ea6ef975d31e0fe4780",
"email": "grumpy@example.com",
"first_name": "Grumpy",
"fullname": "Grumpy Dwarf",
"id": 4,
"last_name": "Dwarf",
"links": {
"self": {
"href": "http://reviews.example.com/api/users/grumpy/",
"method": "GET"
},
"watched": {
"href": "http://reviews.example.com/api/users/grumpy/watched/",
"method": "GET"
}
},
"url": "/users/grumpy/",
"username": "grumpy"
}
]
}