Todos API
v1.0 • REST • JSON
Full CRUD management for todo accounts. Create, retrieve, update, and delete todo records with built-in pagination and role-based access control support.
Quick Reference
/api/todos
200 OK
Get All Todos
Retrieves a paginated list of all todos in the system. Use the page
and limit query parameters to navigate large result sets.
The response envelope includes total count and page metadata.
| Parameter | Type | Default | Description |
|---|---|---|---|
page |
integer | 1 |
Page number, 1-based index |
limit |
integer | 10 |
Number of records per page |
/api/todos/{id}
200 OK
Get Single Todo
Fetch the full profile for a specific todo using their numeric ID. Returns all todo fields including assigned role names and account metadata.
| Parameter | Type | Required | Description |
|---|---|---|---|
id |
integer | Required | Unique todo identifier |
/api/todos/{id}
404 Not Found
Todo Not Found
Returned when the requested todo ID does not exist in the system. Use this example to test error-handling logic and build graceful fallback UI for missing todo resources.
/api/todos
201 Created
Create Todo
Registers a new todo with the provided details. On success, returns the newly created todo object including the auto-generated ID, timestamp, and resolved role names.
| Field | Type | Required | Description |
|---|---|---|---|
title |
string | Required | Title |
description |
string | Required | Description |
isCompleted |
boolean | Required | Is completed |
userId |
integer | Optional | User id |
/api/todos/{id}
200 OK
Update Todo
Fully replaces an existing todo's data with the values in the request body. A successful update returns 200 OK with response body.
| Field | Type | Required | Description |
|---|---|---|---|
title |
string | Required | Title |
description |
string | Required | Description |
isCompleted |
boolean | Required | Is completed |
userId |
integer | Optional | User id |
/api/todos/{id}
204 No Content
Delete Todo
Permanently removes a todo from the system by their ID. This action is irreversible once deleted, the todo record and all associated data cannot be recovered through the API.
| Parameter | Type | Required | Description |
|---|---|---|---|
id |
integer | Required | ID of the todo to delete |