Get task documents

Returns a list of document links for the specified task, if associated with the authenticated client.

GET /tasks/{taskId}/documents

Get task documents

cURL

curl --request GET \
  --url https://api.smokeball.com/tasks/{taskId}/documents \
  --header 'Authorization: <api-key>' \
  --header 'x-api-key: <api-key>'

200

{
  "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"
      },
      "task": {
        "id": "<string>",
        "href": "<string>",
        "relation": "<string>",
        "method": "GET"
      },
      "type": 0,
      "isDeleted": false,
      "document": "<unknown>"
    }
  ]
}

Authorizations

x-api-key · string · header · required

Authorization · string · header · required

Path Parameters

taskId · string<uuid> · required

Response

200

application/json

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

id · string | null

href · string | null

relation · string | null

method · string | null · default: GET

self · object

Show child attributes

value · object[] | null

Show child attributes