Attachments
Attachments are the files on your records, such as screenshots and documents on a task, a bug report, a session or a note. List a record's attachments with a download link for each, upload a file by requesting an upload link and sending the file to it, edit an attachment's description, and delete it.
List attachments on an entity
Returns the file attachments scoped to a parent entity. Each item includes a freshly-issued presigned download URL.
path Parameters
workspaceIdWorkspace UUID
query Parameters
entityParent entity type
entityIdParent entity UUID
pagePage number (1-indexed, default 1)
limitItems per page (default 50)
searchFull-text search across searchable fields
List attachments on an entity › Responses
List of attachments
Request a presigned upload URL for an attachment on any entity
Polymorphic attachment upload. Pass entity (one of the values the request schema lists) and entityId to attach the file to its parent, and a contentType the schema lists. Creates the attachment row and returns a presigned URL the client uses to PUT the bytes. A file may be up to 10 MB, or 100 MB for a video. Optional description annotates why the file was added.
path Parameters
workspaceIdWorkspace UUID
Request a presigned upload URL for an attachment on any entity › Request Body
entityentityIdfileNamecontentTypefileSizedescriptionRequest a presigned upload URL for an attachment on any entity › Responses
Presigned upload URL and attachment metadata
Update an attachment
Currently only description is editable. Pass null to clear.
path Parameters
workspaceIdWorkspace UUID
attachmentIdAttachment UUID
Update an attachment › Request Body
New description for the attachment. Pass null to clear it.
Update an attachment › Responses
Updated attachment