Users
User profile records with names, usernames, emails, address details, and avatar seeds. All mutations persist in your isolated session overlay.
List All Users
Retrieve a paginated list of users. Results merge shared global user records with session sandbox overlays (newly created users appear at the top).
Request Endpoint
GEThttps://playground.nileslabs.com/api/v1/users
Parameters
| Parameter | Type | Description |
|---|---|---|
| page | integer | Page number (1-indexed). |
| limit | integer | Number of records per page (default 10, max 200). |
| q | string | Full-text search query term across name, username, email. |
| _sort | string | Field name to sort results by (name, username, email). |
| _order | string | Sort direction: asc or desc. |
1
{
2
"data": [
3
{
4
"id": "local-a1b2c3d4-e5f6-7890-abcd-ef1234567890",
5
"name": "Jane Doe",
6
"username": "janedoe",
7
"email": "jane.doe@example.com",
8
"_sandbox": "created"
9
},
10
{
11
"id": 1,
12
"name": "Leanne Graham",
13
"username": "Bret",
14
"email": "Sincere@april.biz",
15
"phone": "+1-770-555-0123",
16
"website": "hildegard.org"
17
}
18
],
19
"pagination": {
20
"page": 1,
21
"limit": 10,
22
"total": 25,
23
"totalPages": 3,
24
"hasNextPage": true,
25
"hasPrevPage": false
26
}
27
}
Get Single User
Retrieve a single user by ID. Supports plain integer IDs for global records (e.g. 1) and string IDs formatted as local-<uuid> for sandbox records.
Request Endpoint
GEThttps://playground.nileslabs.com/api/v1/users/:id
Parameters
| Parameter | Type | Description |
|---|---|---|
| id | string | integer | User ID (global integer or local-<uuid>). |
1
{
2
"id": 1,
3
"name": "Leanne Graham",
4
"username": "Bret",
5
"email": "Sincere@april.biz",
6
"phone": "+1-770-555-0123",
7
"website": "hildegard.org",
8
"address": {
9
"street": "Kulas Light",
10
"city": "Gwenborough",
11
"zipcode": "92998-3874"
12
},
13
"company": {
14
"name": "Romaguera-Crona",
15
"catchPhrase": "Multi-layered client-server neural-net"
16
}
17
}
Create New User
Create a new session sandbox user record. Returns a local-<uuid> formatted ID with _sandbox: "created". Capped at 30 custom created records per session.
Request Endpoint
POSThttps://playground.nileslabs.com/api/v1/users
Request Body Example
1
{
2
"name": "Jane Doe",
3
"username": "janedoe",
4
"email": "jane.doe@example.com",
5
"phone": "+1-555-01999",
6
"website": "https://janedoe.dev"
7
}
1
{
2
"id": "local-a1b2c3d4-e5f6-7890-abcd-ef1234567890",
3
"name": "Jane Doe",
4
"username": "janedoe",
5
"email": "jane.doe@example.com",
6
"_sandbox": "created"
7
}
Replace User (PUT)
Replace an existing user record in the session overlay. Global baseline records remain untouched for all other developers.
Request Endpoint
PUThttps://playground.nileslabs.com/api/v1/users/:id
Request Body Example
1
{
2
"name": "Leanne Graham (Updated)",
3
"username": "Bret",
4
"email": "bret.updated@april.biz",
5
"website": "https://updated-user.dev"
6
}
1
{
2
"id": 1,
3
"name": "Leanne Graham (Updated)",
4
"username": "Bret",
5
"email": "bret.updated@april.biz",
6
"website": "https://updated-user.dev",
7
"_sandbox": "updated"
8
}
Partial User Update (PATCH)
Partially update specific profile fields of a user record in your session overlay.
Request Endpoint
PATCHhttps://playground.nileslabs.com/api/v1/users/:id
Request Body Example
1
{
2
"name": "Leanne Graham (Patched)",
3
"website": "https://patched-user.dev"
4
}
1
{
2
"id": 1,
3
"name": "Leanne Graham (Patched)",
4
"username": "Bret",
5
"email": "Sincere@april.biz",
6
"website": "https://patched-user.dev",
7
"_sandbox": "updated"
8
}
Delete User
Remove a user record from your session view. The underlying global baseline record is unaffected for other users.
Request Endpoint
DELETEhttps://playground.nileslabs.com/api/v1/users/:id
1
204 No Content
Get User Posts Sub-Resource
Retrieve all blog posts authored by a specific user with full pagination, search query, and sorting support.
Request Endpoint
GEThttps://playground.nileslabs.com/api/v1/users/:userId/posts
Parameters
| Parameter | Type | Description |
|---|---|---|
| userId | string | integer | Author user ID (e.g. 1 or local-<uuid>). |
| page | integer | Page number (1-indexed). |
| limit | integer | Number of posts per page. |
| q | string | Search term across post title and body. |
| _sort | string | Field name to sort by (title, id, created_at). |
| _order | string | Sort direction: asc or desc. |
1
{
2
"data": [
3
{
4
"id": 1,
5
"user_id": 1,
6
"title": "sunt aut facere repellat provident occaecati excepturi optio reprehenderit",
7
"body": "quia et suscipit suscipit recusandae consequuntur expedita et cum reprehenderit molestiae ut ut quas totam nostrum rerum est autem sunt rem eveniet architecto"
8
},
9
{
10
"id": 2,
11
"user_id": 1,
12
"title": "qui est esse",
13
"body": "est rerum tempore vitae sequi sint nihil reprehenderit dolor beatae ea dolores neque fugiat blanditiis voluptate porro vel nihil molestiae ut reiciendis"
14
}
15
],
16
"pagination": {
17
"page": 1,
18
"limit": 10,
19
"total": 4,
20
"totalPages": 1,
21
"hasNextPage": false,
22
"hasPrevPage": false
23
}
24
}
Get User Todos Sub-Resource
Retrieve all task todos assigned to a specific user, with optional completion status filtering.
Request Endpoint
GEThttps://playground.nileslabs.com/api/v1/users/:userId/todos
Parameters
| Parameter | Type | Description |
|---|---|---|
| userId | string | integer | Owner user ID (e.g. 1 or local-<uuid>). |
| completed | boolean | Filter tasks by completion status (true or false). |
| page | integer | Page number (1-indexed). |
| limit | integer | Number of todos per page. |
| _sort | string | Field name to sort by (title, id, completed). |
| _order | string | Sort direction: asc or desc. |
1
{
2
"data": [
3
{
4
"id": 1,
5
"user_id": 1,
6
"title": "delectus aut autem",
7
"completed": false
8
},
9
{
10
"id": 2,
11
"user_id": 1,
12
"title": "quis ut nam facilis et officia qui",
13
"completed": false
14
},
15
{
16
"id": 3,
17
"user_id": 1,
18
"title": "fugiat veniam minus",
19
"completed": false
20
},
21
{
22
"id": 4,
23
"user_id": 1,
24
"title": "et porro tempora",
25
"completed": true
26
},
27
{
28
"id": 5,
29
"user_id": 1,
30
"title": "laboriosam mollitia et enim quasi adipisci quia provident illum",
31
"completed": false
32
}
33
],
34
"pagination": {
35
"page": 1,
36
"limit": 10,
37
"total": 5,
38
"totalPages": 1,
39
"hasNextPage": false,
40
"hasPrevPage": false
41
}
42
}