Skip to main content
GET
/
tasks
/
{id}
Get a task
curl --request GET \
  --url https://api.smokeball.com/tasks/{id} \
  --header 'Authorization: <api-key>' \
  --header 'x-api-key: <api-key>'
{
  "id": "<string>",
  "href": "<string>",
  "relation": "<string>",
  "method": "GET",
  "self": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "GET"
  },
  "matter": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "<string>"
  },
  "parentTask": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "<string>"
  },
  "createdBy": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "<string>"
  },
  "completedBy": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "<string>"
  },
  "lastUpdatedBy": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "<string>"
  },
  "assignees": [
    {
      "id": "<string>",
      "href": "<string>",
      "relation": "<string>",
      "method": "<string>"
    }
  ],
  "subTasks": [
    {
      "id": "<string>",
      "href": "<string>",
      "relation": "<string>",
      "method": "<string>"
    }
  ],
  "subject": "Review contract for John Smith",
  "note": "Contract needs to be reviewed and discussed with John",
  "categories": [
    "<string>"
  ],
  "dueDate": "2020-02-15T00:00:00Z",
  "completedDate": "2020-02-15T00:00:00Z",
  "createdDate": "2020-02-15T00:00:00Z",
  "isCompleted": false,
  "isDeleted": false,
  "lastUpdated": 637847425252027400,
  "duration": "PT4H33M"
}

Authorizations

x-api-key
string
header
required
Authorization
string
header
required

Path Parameters

id
string<uuid>
required

Response

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

id
string | null
href
string | null
relation
string | null
method
string | null
default:GET
self
object
matter
object

Matter associated to the task.

parentTask
object

The parent task associated to this task. Id is missing if this task is not a sub task.

createdBy
object

The staff member who created the task.

completedBy
object

The staff member who completed the task.

lastUpdatedBy
object

The staff member who last updated the task.

assignees
object[] | null

The staff member(s) assigned to the task.

subTasks
object[] | null

The tasks associated to the task.

subject
string | null

The subject - a short description of the task.

Example:

"Review contract for John Smith"

note
string | null

Notes on the task.

Example:

"Contract needs to be reviewed and discussed with John"

categories
string[] | null

Categories for the task.

dueDate
string<date-time> | null

The due date of the task.

Example:

"2020-02-15T00:00:00Z"

completedDate
string<date-time> | null

When the task was completed.

Example:

"2020-02-15T00:00:00Z"

createdDate
string<date-time> | null

When the task was created.

Example:

"2020-02-15T00:00:00Z"

isCompleted
boolean

True when the task is completed.

Example:

false

isDeleted
boolean

True when the task is deleted.

Example:

false

lastUpdated
integer

Last updated timestamp.

Example:

637847425252027400

duration
string | null

Duration of the task in ISO 8601 duration format.

Example:

"PT4H33M"

I