SuperDocs Demo

List Users

Retrieve a list of all users in the system

GET /users

Overview

Returns a paginated list of all users. Use query parameters to control pagination and filtering.

Parameters

Query Parameters

_limit
integer = 10

Maximum number of users to return. Use for pagination.

_start
integer = 0

Number of users to skip. Use with _limit for pagination.

Response

id integer

Unique identifier for the user

name string

Full name of the user

username string

Unique username for the user

email string

Email address of the user

phone string

Phone number of the user

website string

Personal website URL

address object

User’s physical address including street, city, and zipcode

company object

User’s company information including name and catchphrase

Example Response

[
{
"id": 1,
"name": "Leanne Graham",
"username": "Bret",
"email": "Sincere@april.biz",
"phone": "1-770-736-8031 x56442",
"website": "hildegard.org",
"address": {
"street": "Kulas Light",
"suite": "Apt. 556",
"city": "Gwenborough",
"zipcode": "92998-3874"
},
"company": {
"name": "Romaguera-Crona",
"catchPhrase": "Multi-layered client-server neural-net"
}
}
]
Try it out
GET /users