Skip to main content
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.

​
id
string | null
​
href
string | null
​
relation
string | null
​
method
string | null
default:GET
​
self
object
​
value
object[] | null
​
offset
integer<int32> | null
​
limit
integer<int32> | null
​
size
integer<int64>
​
first
object
​
previous
object
​
next
object
​
last
object