---
title: "List Todos"
url: "https://kiwi.arashsheyda.me/apis/stoplight-3/versions/8b88146a-3da5-4ca7-8179-7ad4727ac5a1/operations/get-todos"
---

> Full API specification: https://kiwi.arashsheyda.me/apis/stoplight-3/versions/8b88146a-3da5-4ca7-8179-7ad4727ac5a1.md

# List Todos

`GET` `/todos`

Operation ID: `get-todos`

Returns a list of todos *Markdown is supported in descriptions. Add information here for users to get accustomed to endpoints*

## Query parameters

- `limit` (number, optional) - Return a limited set of results *I'm a shared parameter. I can be reused in multiple endpoints!*

## Responses

- `200` - Returns a list of Todos
- `403` - Action not allowed
- `404` - Resource not found

## OpenAPI definition

```yaml
openapi: 3.0.0
info:
  title: To-dos
  version: 1.0.0
servers:
  - url: https://todos.stoplight.io
    description: Production
  - description: Sandbox
    url: https://todos-sandbox.stoplight.io
paths:
  /todos:
    get:
      summary: List Todos
      responses:
        "200":
          description: Returns a list of Todos
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: "#/components/schemas/Todos"
              examples:
                List of Todos:
                  $ref: "#/components/examples/multiple-todos"
        "403":
          $ref: "#/components/responses/Unauthorized"
        "404":
          $ref: "#/components/responses/NotFound"
      operationId: get-todos
      description: >-
        Returns a list of todos


        *Markdown is supported in descriptions. Add information here for users
        to get accustomed to endpoints*
      parameters:
        - $ref: "#/components/parameters/limit"
      security: []
security: []
components:
  schemas:
    Todos:
      description: I'm a model's description.
      type: object
      title: Todo
      properties:
        id:
          type: number
          minimum: 0
          maximum: 9999
          description: ID of the task
          readOnly: true
        name:
          type: string
          minLength: 1
          maxLength: 100
          description: Name of the task
        completed:
          type: boolean
          default: false
          description: Boolean indicating if the task has been completed or not
        completed_at:
          type: string
          format: date-time
          description: Time when the task was completed
          readOnly: true
        created_at:
          type: string
          format: date-time
          description: Time when the task was created
          readOnly: true
        updated_at:
          type: string
          format: date-time
          description: Time when the task was updated
          readOnly: true
      required:
        - id
        - name
        - completed_at
        - created_at
        - updated_at
  examples:
    multiple-todos:
      value:
        - id: 0
          name: my todo
          completed: true
          completed_at: 2019-08-24T14:15:22Z
          created_at: 2019-08-24T14:15:22Z
          updated_at: 2019-08-24T14:15:22Z
        - id: 1
          name: another todo
          completed: false
          completed_at: 2019-08-24T14:15:22Z
          created_at: 2019-08-24T14:15:22Z
          updated_at: 2019-08-24T14:15:22Z
        - id: 2
          name: yet another todo
          completed: false
          completed_at: 2019-08-24T14:15:22Z
          created_at: 2019-08-24T14:15:22Z
          updated_at: 2019-08-24T14:15:22Z
  responses:
    Unauthorized:
      description: Action not allowed
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
            required:
              - message
    NotFound:
      description: Resource not found
      content:
        application/json:
          schema:
            title: Error
            type: object
            description: A standard error object.
            x-tags:
              - Common
            properties:
              status:
                type: string
                description: A code.
              error:
                type: string
            required:
              - status
              - error
  parameters:
    limit:
      name: limit
      in: query
      required: false
      schema:
        type: number
      description: Return a limited set of results *I'm a shared parameter. I can be
        reused in multiple endpoints!*
```