Skip to main content
GET
/
tasks
/
{taskId}
/
subtasks
/
{id}
Get a subtask
curl --request GET \
  --url https://api.smokeball.com/tasks/{taskId}/subtasks/{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"
  },
  "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"
  },
  "subject": "Confer with Mary",
  "completedDate": "2020-02-15T13:00:00Z",
  "completedDateOnly": "2020-02-15T00:00:00",
  "createdDate": "2020-02-15T13:00:00Z",
  "createdDateOnly": "2020-02-15T00:00:00",
  "isCompleted": false,
  "isDeleted": false,
  "lastUpdated": 637847425252027400
}

Authorizations

ā€‹
x-api-key
string
header
required
ā€‹
Authorization
string
header
required

Path Parameters

ā€‹
taskId
string<uuid>
required
ā€‹
id
string<uuid>
required

Response

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

Subtask resource.

ā€‹
id
string | null
ā€‹
href
string | null
ā€‹
relation
string | null
ā€‹
method
string | null
default:GET
ā€‹
self
object
ā€‹
parentTask
object

The parent (task) of the subtask.

ā€‹
createdBy
object

The staff member who created the subtask.

ā€‹
completedBy
object

The staff member who completed the subtask.

ā€‹
lastUpdatedBy
object

The staff member who last updated the subtask.

ā€‹
subject
string | null

The subject - a short description of the subtask.

Example:

"Confer with Mary"

ā€‹
completedDate
string<date-time> | null
deprecated

Deprecated. Use CompletedDateOnly instead.

When the subtask was completed in UTC.

Example:

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

ā€‹
completedDateOnly
string<date-time> | null

The date when the subtask was completed.

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

Example:

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

ā€‹
createdDate
string<date-time> | null
deprecated

Deprecated. Use CreatedDateOnly instead.

When the subtask was created in UTC.

Example:

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

ā€‹
createdDateOnly
string<date-time> | null

The date when the subtask was created.

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

Example:

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

ā€‹
isCompleted
boolean

True when the subtask is completed.

Example:

false

ā€‹
isDeleted
boolean

True when the subtask is deleted.

Example:

false

ā€‹
lastUpdated
integer<int64>

Last updated timestamp.

Example:

637847425252027400