Skip to main content
GET
/
tasks
/
{taskId}
/
documents
/
{id}
Get a task document
curl --request GET \
  --url https://api.smokeball.com/tasks/{taskId}/documents/{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"
  },
  "task": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "<string>"
  },
  "type": 0,
  "isDeleted": false,
  "document": "<any>"
}

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 'Link' object.

Task document resource.

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

The associated task.

​
type
enum<integer>

The type of the document.

Possible values: File = 0, FormTemplate = 1, Memo = 2. Available document types: "File = 0", "FormTemplate = 1", "Memo = 2"

The FormTemplate (1) document type is not currently supported for task document creation.

Available options:
0,
1,
2
Example:

0

​
isDeleted
boolean

True when the task document has been deleted.

Example:

false

​
document
any

Link to the the document.

⌘I