Get all users.
get
/learn.rest/v1/users
Request
Query Parameters
-
limit(optional): integer
Specify how many items should be returned in a payload. Must be lower than server default limit size.
-
offset(optional): integer
Specify starting point of the response.Default Value:
0 -
q: string
Search through users collection items. Use Mongo DB Query format. Searchable properties are - username, email, employeeId. example ?q={email:{$eq: 'user@example.com'}}
-
totalResults(optional): boolean
If set to true, the payload includes the total number of rows that satisfies the request. Use of this parameter determines if the 'last' link is displayed for a pageable collection.
Security
-
auth: basic
Type:
basicDescription:Basic Authentication
Response
Supported Media Types
- application/xml
- application/json
200 Response
Users collection fetched.
Root Schema : UsersResponse
Type:
Show Source
object-
count(optional):
number
Example:
100 -
hasMore(optional):
boolean
Example:
true -
items(optional):
array items
-
limit(optional):
number
Example:
100 -
links(optional):
array links
Nested Schema : User
Type:
Show Source
object-
city(optional):
string
Example:
Redwood Shores -
company(optional):
string
Example:
oracle -
country(optional):
string
Example:
USA -
createdDate(optional):
string(datetime)
Example:
2013-10-12T11:00:00-04:00 -
department(optional):
string
Example:
sales -
email(optional):
string
Example:
info@example.com -
email2(optional):
string
Example:
-
employeeId(optional):
string
Example:
H123 -
fax(optional):
string
Example:
n/a -
firstName(optional):
string
Example:
cwal -
gender(optional):
string
Allowed Values:
[ "male", "female" ]enum for gender are: male, femaleExample:male -
id(optional):
number
Example:
123123 -
includeInSearchFlag(optional):
boolean
Example:
false -
jobTitle(optional):
string
Example:
sales manager -
lastAccesedDate(optional):
string(datetime)
Example:
2015-11-12T11:00:00-04:00 -
lastName(optional):
string
Example:
lace -
lastUpdatedByUser(optional):
array lastUpdatedByUser
-
lastUpdatedByUserId(optional):
number
Example:
123123 -
lastUpdatedDate(optional):
string(datetime)
Example:
2017-10-12T11:00:00-04:00 -
managerName(optional):
string
Example:
n/a -
officeName(optional):
string
Example:
n/a -
pager(optional):
string
Example:
n/a -
pagerInteractive(optional):
string
Example:
n/a -
passwordValidUntilDate(optional):
string(datetime)
Example:
2016-10-12T11:00:00-04:00 -
phoneDaytime(optional):
string
Example:
+1.800.392.2999 -
phoneEvening(optional):
string
Example:
n/a -
phoneMobile(optional):
string
Example:
+1.800.392.2999 -
postalCode(optional):
string
Example:
94065 -
profession(optional):
string
Example:
software engineer -
ssn(optional):
string
Example:
n/a -
state(optional):
string
Example:
CA -
street1(optional):
string
Example:
500 Oracle Parkway -
street2(optional):
string
Example:
suite 500 -
username(optional):
string
Username of the userExample:
cwallace
Nested Schema : UserLink
Type:
Show Source
object-
href(optional):
string
Example:
{url}/learn.rest/v1/users/456 -
rel(optional):
string
Example:
canonical
Nested Schema : items
Type:
Show Source
objectExample:
[
{
"rel":"canonical",
"href":"{url}/learn.rest/v1/users"
},
{
"rel":"first",
"href":"{url}/v1/users?limit=100&offset=0"
},
{
"rel":"prev",
"href":"{url}/learn.rest/v1/users?limit=100&offset=0"
},
{
"rel":"next",
"href":"{url}/learn.rest/v1/users?limit=100&offset=10"
},
{
"rel":"last",
"href":"{url}/learn.rest/v1/users?limit=100&offset=1200"
}
]401 Response
500 Response
Internal server error.