v1

latestOpenAPI 3.1.02026-07-24172151607.6 KB
Attachments

Get Attachments

Return a list of attachments for the specified entity, including a task or File type Custom Field.

get/api/v3/workspaces/{workspace_id}/{entity_type}/{entity_id}/attachments

Path parameters

workspace_idinteger required

The ID of the Workspace.

entity_type'attachments' | 'custom_fields' required

The entity type. Options include attachments for tasks and custom_fields for a File type Custom Field.

entity_idstring required

The ID of the task or Custom Field.

Query parameters

cursorstring

The cursor to use to fetch the next page of results.

limitinteger

The maximum number of results to fetch for this page.

Response

next_cursorstring required

The next cursor to use for pagination.

Example response

{
  "data": [
    {
      "date_updated": 1737065673712,
      "date_created": 1737065673712,
      "extension": "png",
      "id": "51971815-ae25-49d5-b90c-4988f400a307.png",
      "mime_type": "image/png",
      "parent_entity_type": "tasks",
      "size": 14697,
      "signed": true,
      "title": "An example image"
    }
  ]
}