Search
K
stoplight

To-dos

1.0.0OAS 3.0

💫 Overview

To Do API provides a simple way for people to manage their tasks and plan their day. This API can be used to create mobile and web applications.This API is documented using OpenAPI 3.0. The implementation lives in this GitHub repo.

🧰 Cross-Origin Resource Sharing

This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with W3C spec. CORS support is necessary to make calls from the request maker within the API docs.

🏁 Trying out your own API Specification

Elements can be used to generate API docs for any OpenAPI document. Replace this OpenAPI with a URL to your own OpenAPI document to get started.

API Base URL
  • Server 1:https://todos.stoplight.io

    Production

  • Server 2:https://todos-sandbox.stoplight.io

    Sandbox

Security
API Key (apiKey)

Just use 123. It’s super secure ;)

Additional Information
Contact Stoplight Support (support@stoplight.io)
MIT License

List Todos

Returns a list of todos

Markdown is supported in descriptions. Add information here for users to get accustomed to endpoints

get

Query Parameters

limitnumber

Return a limited set of results I’m a shared parameter. I can be reused in multiple endpoints!

Response

application/json

Returns a list of Todos

I’m a model’s description.

idnumberrequiredread-only

ID of the task

>= 0<= 9999

namestringrequired

Name of the task

>= 1 characters<= 100 characters

completedboolean

Boolean indicating if the task has been completed or not

Default:false

completed_atstring(date-time)requiredread-only

Time when the task was completed

created_atstring(date-time)requiredread-only

Time when the task was created

updated_atstring(date-time)requiredread-only

Time when the task was updated

 
application/json

Create Todo

This creates a Todo object

Markdown is supported in descriptions. Add information here for users to get accustomed to endpoints

post

Body

application/json

Name of the Todo

Todo

I’m a model’s description.

namestringrequired

Name of the task

>= 1 characters<= 100 characters

completedboolean

Boolean indicating if the task has been completed or not

Default:false

Response

multipart/form-data

New Todo Created

Todo

I’m a model’s description.

idnumberrequiredread-only

ID of the task

>= 0<= 9999

namestringrequired

Name of the task

>= 1 characters<= 100 characters

completedboolean

Boolean indicating if the task has been completed or not

Default:false

completed_atstring(date-time)requiredread-only

Time when the task was completed

created_atstring(date-time)requiredread-only

Time when the task was created

updated_atstring(date-time)requiredread-only

Time when the task was updated

 
multipart/form-data