SMsmokeball
Tasks

Get a task

Retrieves a specified task.

get/tasks/{id}

Request

  • Base URL
    https://api.smokeball.com
  • URL
    https://api.smokeball.com/tasks/{id}
  • Auth
    API key in header x-api-key and API key in header Authorization

Path parameters

idstring uuid required

Response

When request is successful. Returns a 'Task' object.

idstring nullable
hrefstring nullable
relationstring nullable
methodstring nullable
subjectstring nullable

The subject - a short description of the task.

notestring nullable

Notes on the task.

categoriesstring[] nullable

Categories for the task.

dueDatestring date-time nullable

Deprecated. Use DueDateOnly instead.

The due date of the task in UTC.

dueDateOnlystring date-time nullable

The due date of the task.

The time portion will always be set to 00:00:00 and should be ignored. Only the date portion is relevant.

completedDatestring date-time nullable

Deprecated. Use CompletedDateOnly instead.

When the task was completed in UTC.

completedDateOnlystring date-time nullable

The date when the task was completed.

The time portion will always be set to 00:00:00 and should be ignored. Only the date portion is relevant.

createdDatestring date-time nullable

Deprecated. Use CreatedDateOnly instead.

When the task was created in UTC.

createdDateOnlystring date-time nullable

The date when the task was created.

The time portion will always be set to 00:00:00 and should be ignored. Only the date portion is relevant.

isCompletedboolean

True when the task is completed.

isDeletedboolean

True when the task is deleted.

lastUpdatedinteger

Last updated timestamp.

durationstring nullable

Duration of the task in ISO 8601 duration format.

Example response

{
  "subject": "Review contract for John Smith",
  "note": "Contract needs to be reviewed and discussed with John",
  "dueDate": "2020-02-15T13:00:00Z",
  "dueDateOnly": "2020-02-15T00:00:00",
  "completedDate": "2020-02-15T13:00:00Z",
  "completedDateOnly": "2020-02-15T00:00:00",
  "createdDate": "2020-02-15T13:00:00Z",
  "createdDateOnly": "2020-02-15T00:00:00",
  "lastUpdated": 637847425252027400,
  "duration": "PT4H33M"
}

Changes

No recorded changes to this operation across all 15 revisions of this API.