Todo

Get todo item

Changed on

Return a todo item based on the todo id belonging to the current user.

get/v1/todos/{id}

Request

  • Base URL: https://example.com/api
  • URL: https://example.com/api/v1/todos/{id}
  • Auth: OAuth 2 (authorization code, authorization URL /oauth/authorize, token URL /oauth/token; client credentials, token URL /oauth/token; password, token URL /oauth/token, scopes: todo.read)

Response

OK

idstring required

Unique identifier of the todo.

titlestring required

Title of the todo item.

descriptionstring required

Description of the todo item.

priority'normal' | 'important' | 'urgent' | 'critical' required

Priority of the todo item.

completedboolean required

Status of the todo item.

owned_bystring required

ID of the user who owns the todo item.

created_bystring required

ID of the user who created the todo item.

due_datestring date-time nullable required

Completion due date of the todo item.

created_atstring date-time required

Date when the todo item was created.

updated_atstring date-time nullable required

Date when the todo item was updated.

Example response

{
  "id": "9bsv0s46s6s002p9ltq0",
  "title": "Do something great",
  "description": "I'll make the world a better place today.",
  "priority": "urgent"
}

Changes

  • 8a34c0b5508eRevision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 1057260fde29Revision changes
    • info

      api tag Todo added

    • info

      api tag Todos removed