Users
List users
get/users
Request
- Base URLhttps://gorest.co.in/public/v3
- URLhttps://gorest.co.in/public/v3/users
- Auth
- none
- or HTTP bearer
Query parameters
page[size]integer
Items on one page.
page[after]string
The cursor of the next page, from meta.next_cursor or the Link header. Treat it as opaque; it works only with the same query.
page[number]integer
Offset paging, 1 based, at most 10,000. Cannot be sent with page[after]. Pages can shift while you write.
page[count]boolean
true adds meta.total to a cursor page (it costs a count).
searchstring
Case-insensitive text search over the resource's text fields.
filter[status]=active,inactive (any of), filter[email]= (exact, lower case).
sort'created_at' | '-created_at' | 'name' | '-name' | 'email' | '-email'
One field; a leading - sorts descending. Default -created_at.
fields[users]=id,name returns only those fields.
Headers
If-None-Matchstring
An ETag from an earlier answer; an unchanged item answers 304 with no body.
Response
One page of users.
Example response
{
"data": [
{
"email": "aarav.sharma@example.com",
"name": "Aarav Sharma"
}
]
}Changes
No recorded changes to this operation across all 1 revision of this API.