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": "GET"
  },
  "type": 0,
  "isDeleted": false,
  "document": "<unknown>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.smokeball.com/llms.txt

Use this file to discover all available pages before exploring further.

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 options:
0,
1,
2
Example:

0

ā€‹
isDeleted
boolean

True when the task document has been deleted.

Example:

false

ā€‹
document
any | null

Link to the the document.