Get tasks

curl --request GET \
  --url https://api.smokeball.com/tasks \
  --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"
  },
  "value": [
    {
      "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": "GET"
      },
      "parentTask": {
        "id": "<string>",
        "href": "<string>",
        "relation": "<string>",
        "method": "GET"
      },
      "createdBy": {
        "id": "<string>",
        "href": "<string>",
        "relation": "<string>",
        "method": "GET"
      },
      "completedBy": {
        "id": "<string>",
        "href": "<string>",
        "relation": "<string>",
        "method": "GET"
      },
      "lastUpdatedBy": {
        "id": "<string>",
        "href": "<string>",
        "relation": "<string>",
        "method": "GET"
      },
      "assignees": [
        {
          "id": "<string>",
          "href": "<string>",
          "relation": "<string>",
          "method": "GET"
        }
      ],
      "subTasks": [
        {
          "id": "<string>",
          "href": "<string>",
          "relation": "<string>",
          "method": "GET"
        }
      ],
      "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"
    }
  ],
  "offset": 123,
  "limit": 123,
  "size": 123,
  "first": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "GET"
  },
  "previous": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "GET"
  },
  "next": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "GET"
  },
  "last": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "GET"
  }
}

GET

tasks

Get tasks

curl --request GET \
  --url https://api.smokeball.com/tasks \
  --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"
  },
  "value": [
    {
      "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": "GET"
      },
      "parentTask": {
        "id": "<string>",
        "href": "<string>",
        "relation": "<string>",
        "method": "GET"
      },
      "createdBy": {
        "id": "<string>",
        "href": "<string>",
        "relation": "<string>",
        "method": "GET"
      },
      "completedBy": {
        "id": "<string>",
        "href": "<string>",
        "relation": "<string>",
        "method": "GET"
      },
      "lastUpdatedBy": {
        "id": "<string>",
        "href": "<string>",
        "relation": "<string>",
        "method": "GET"
      },
      "assignees": [
        {
          "id": "<string>",
          "href": "<string>",
          "relation": "<string>",
          "method": "GET"
        }
      ],
      "subTasks": [
        {
          "id": "<string>",
          "href": "<string>",
          "relation": "<string>",
          "method": "GET"
        }
      ],
      "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"
    }
  ],
  "offset": 123,
  "limit": 123,
  "size": 123,
  "first": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "GET"
  },
  "previous": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "GET"
  },
  "next": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "GET"
  },
  "last": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "GET"
  }
}

Authorizations

x-api-key

string

header

required

Authorization

string

header

required

Query Parameters

Offset

integer<int32>

Required range: 0 <= x <= 2147483647

Limit

integer<int32>

Required range: 1 <= x <= 500

MatterId

string

Filter by tasks that are assigned to the specified matter id..

Example:

"1bf55840-cba3-4f8a-8c0f-66082692e493"

IsCompleted

boolean

Filter by tasks tasks that have been completed. Leave blank if

Example:

true

UpdatedSince

integer<int64>

Filter by tasks updated since a specified time (.net ticks representation of the UTC datetime). Cannot be used in conjunction with LastUpdated.

This field will not be supported in future, please use LastUpdated instead.

Example:

637873555398585000

LastUpdated

string<date-time>

Filter by last updated date of a task. Cannot be used in conjunction with UpdatedSince.

Example:

"2022-04-23T14:00:00Z"

Response

When request is successful. Returns a list of 'Task' objects.

string | null

href

string | null

relation

string | null

method

string | null

default:GET

self

object

Show child attributes

self.id

string | null

self.href

string | null

self.relation

string | null

self.method

string | null

default:GET

value

object[] | null

Show child attributes

value.id

string | null

value.href

string | null

value.relation

string | null

value.method

string | null

default:GET

value.self

object

Show child attributes

value.self.id

string | null

value.self.href

string | null

value.self.relation

string | null

value.self.method

string | null

default:GET

value.matter

object

Matter associated to the task.

Show child attributes

value.matter.id

string | null

value.matter.href

string | null

value.matter.relation

string | null

value.matter.method

string | null

default:GET

value.parentTask

object

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

Show child attributes

value.parentTask.id

string | null

value.parentTask.href

string | null

value.parentTask.relation

string | null

value.parentTask.method

string | null

default:GET

value.createdBy

object

The staff member who created the task.

Show child attributes

value.createdBy.id

string | null

value.createdBy.href

string | null

value.createdBy.relation

string | null

value.createdBy.method

string | null

default:GET

value.completedBy

object

The staff member who completed the task.

Show child attributes

value.completedBy.id

string | null

value.completedBy.href

string | null

value.completedBy.relation

string | null

value.completedBy.method

string | null

default:GET

value.lastUpdatedBy

object

The staff member who last updated the task.

Show child attributes

value.lastUpdatedBy.id

string | null

value.lastUpdatedBy.href

string | null

value.lastUpdatedBy.relation

string | null

value.lastUpdatedBy.method

string | null

default:GET

value.assignees

object[] | null

The staff member(s) assigned to the task.

Show child attributes

value.assignees.id

string | null

value.assignees.href

string | null

value.assignees.relation

string | null

value.assignees.method

string | null

default:GET

value.subTasks

object[] | null

The tasks associated to the task.

Show child attributes

value.subTasks.id

string | null

value.subTasks.href

string | null

value.subTasks.relation

string | null

value.subTasks.method

string | null

default:GET

value.subject

string | null

The subject - a short description of the task.

Example:

"Review contract for John Smith"

value.note

string | null

Notes on the task.

Example:

"Contract needs to be reviewed and discussed with John"

value.categories

string[] | null

Categories for the task.

value.dueDate

string<date-time> | null

The due date of the task.

Example:

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

value.completedDate

string<date-time> | null

When the task was completed.

Example:

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

value.createdDate

string<date-time> | null

When the task was created.

Example:

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

value.isCompleted

boolean

True when the task is completed.

Example:

false

value.isDeleted

boolean

True when the task is deleted.

Example:

false

value.lastUpdated

integer<int64>

Last updated timestamp.

Example:

637847425252027400

value.duration

string | null

Duration of the task in ISO 8601 duration format.

Example:

"PT4H33M"

offset

integer<int32> | null

limit

integer<int32> | null

size

integer<int64>

first

object

Show child attributes

first.id

string | null

first.href

string | null

first.relation

string | null

first.method

string | null

default:GET

object

Show child attributes

previous.id

string | null

previous.href

string | null

previous.relation

string | null

previous.method

string | null

default:GET

object

Show child attributes

next.id

string | null

next.href

string | null

next.relation

string | null

next.method

string | null

default:GET

last

object

Show child attributes

last.id

string | null

last.href

string | null

last.relation

string | null

last.method

string | null

default:GET

Delete a task Create a task

⌘I

Documentation

Tutorials

APIs

Get tasks

Authorizations

Query Parameters

Response