Skip to content

Work item attachments overview ​

Attachments are files uploaded against a work item.

The attachment object ​

Attributes ​

  • asset_url string

    The asset url.

  • attributes string

    The attributes.

  • content_type string

    The content type.

  • created_at string (date-time)

    When the record was created.

  • created_by_id string (uuid)

    The user who created the record.

  • external_id string

    Your system's identifier for this record, for sync and import correlation.

  • external_source string

    The system external_id came from, for example github or jira.

  • id string (uuid)

    Unique identifier.

  • is_uploaded boolean

    Whether is uploaded.

  • name string

    Display name.

  • size number

    The size.

  • work_item_id string (uuid)

    The related work item.

Response200
json
{
  "asset_url": "https://example.com",
  "attributes": null,
  "content_type": "example",
  "created_at": "2026-01-14T09:22:41.478363Z",
  "created_by_id": "16c61a3a-512a-48ac-b0be-b6b46fe6f430",
  "external_id": null,
  "external_source": null,
  "id": "b7e42a19-3c5d-4f80-9a26-8d1c0f4e7b53",
  "is_uploaded": false,
  "name": "Example name",
  "size": 1,
  "work_item_id": "f960d3c2-8524-4a41-b8eb-055ce4be2a7f"
}

Endpoints ​

MethodPathDescription
GET/api/v2/workspaces/{slug}/projects/{project_id}/work-items/{work_item_id}/attachments/List attachments
GET/api/v2/workspaces/{slug}/projects/{project_id}/work-items/{work_item_id}/attachments/{pk}/Get an attachment
POST/api/v2/workspaces/{slug}/projects/{project_id}/work-items/{work_item_id}/attachments/Create a work item attachment upload
DELETE/api/v2/workspaces/{slug}/projects/{project_id}/work-items/{work_item_id}/attachments/{pk}/Delete an attachment
PATCH/api/v2/workspaces/{slug}/projects/{project_id}/work-items/{work_item_id}/attachments/{pk}/Confirm a work item attachment upload

Response shaping ​

Every attachment read accepts ?fields= for sparse responses — see Sparse fields. Errors follow the shared problem+json contract.