Todos API

1.0.0OAS 3.0

Manages todos. The billing profile is usage-based: every Todo created costs $0.01 USD. Usage is recorded per created Todo in an append-only ledger and invoiced monthly, per calendar month (UTC). Reads, updates, and deletes are not billable. A Todo starts out incomplete; completedAt is set by the server when completed flips to true and cleared when it flips back to false.

API Base URL
  • Server 1:https://api.rest.rodeo/todos/api/v1

    Production

Security
bearerAuth (http)

Provide your bearer token in the Authorization header when making requests to protected resources.

Example: Authorization: Bearer 123

/todos

Lists every todo.

get
https://api.rest.rodeo/todos/api/v1/todos

Response

application/json

All todos

TodosList

* Additional properties are NOT allowed.
todosarray[object]required
* Additional properties are NOT allowed.
Show Child Parameters
get/todos
 
application/json

/todos

Creates a todo. The todo starts out incomplete and the server sets createdAt and updatedAt. Creating a todo is a billable event charged at $0.01 USD.

post
https://api.rest.rodeo/todos/api/v1/todos

Body

application/json

TodoRequest

* Additional properties are NOT allowed.
namestringrequired

The todo name.

>= 1 characters<= 256 characters

descriptionstringrequired

The todo description.

<= 2000 characters

dueDatestring(date-time)

When the todo is due. Optional; omit or send null for no due date.

Response

application/json

The created todo

Todo

* Additional properties are NOT allowed.
idstring(uuid)required

The todo id.

namestringrequired

The todo name.

>= 1 characters<= 256 characters

descriptionstringrequired

The todo description.

<= 2000 characters

dueDatestring | null(date-time)required

When the todo is due, or null when it has no due date.

completedbooleanrequired

Whether the todo has been completed.

createdAtstring(date-time)required

When the todo was created. This is the billable event.

updatedAtstring(date-time)required

When the todo was last updated.

completedAtstring | null(date-time)required

When the todo was completed, or null while it is incomplete.

post/todos

Body

{ "name": "Book the rodeo", "description": "Reserve seats for the weekend show.", "dueDate": "2026-10-15T17:00:00.000Z" }
 
application/json

/todos/{todoId}

Returns a single todo by id.

get
https://api.rest.rodeo/todos/api/v1/todos/{todoId}

Path Parameters

todoIdstring(uuid)required

The todo id.

Response

application/json

The todo

Todo

* Additional properties are NOT allowed.
idstring(uuid)required

The todo id.

namestringrequired

The todo name.

>= 1 characters<= 256 characters

descriptionstringrequired

The todo description.

<= 2000 characters

dueDatestring | null(date-time)required

When the todo is due, or null when it has no due date.

completedbooleanrequired

Whether the todo has been completed.

createdAtstring(date-time)required

When the todo was created. This is the billable event.

updatedAtstring(date-time)required

When the todo was last updated.

completedAtstring | null(date-time)required

When the todo was completed, or null while it is incomplete.

get/todos/{todoId}
 
application/json

/todos/{todoId}

Replaces the todo’s name, description, and dueDate. Omitting dueDate clears it. Optionally toggles completed; the server sets completedAt to the update time when the todo flips to complete and clears it when it flips back to incomplete. Bumps updatedAt to the update time.

put
https://api.rest.rodeo/todos/api/v1/todos/{todoId}

Path Parameters

todoIdstring(uuid)required

The todo id.

Body

application/json

TodoUpdateRequest

* Additional properties are NOT allowed.
namestringrequired

The todo name.

>= 1 characters<= 256 characters

descriptionstringrequired

The todo description.

<= 2000 characters

dueDatestring(date-time)

When the todo is due. Optional; omitting it clears the due date.

completedboolean

Whether the todo has been completed. Optional; omitting it leaves the completion state unchanged.

Response

application/json

The updated todo

Todo

* Additional properties are NOT allowed.
idstring(uuid)required

The todo id.

namestringrequired

The todo name.

>= 1 characters<= 256 characters

descriptionstringrequired

The todo description.

<= 2000 characters

dueDatestring | null(date-time)required

When the todo is due, or null when it has no due date.

completedbooleanrequired

Whether the todo has been completed.

createdAtstring(date-time)required

When the todo was created. This is the billable event.

updatedAtstring(date-time)required

When the todo was last updated.

completedAtstring | null(date-time)required

When the todo was completed, or null while it is incomplete.

put/todos/{todoId}

Body

{ "name": "Book the rodeo", "description": "Seats are reserved for the weekend show.", "dueDate": "2026-10-16T17:00:00.000Z", "completed": true }
 
application/json