Sign in

v1

latestOpenAPI 3.1.02026-07-24172151607.6 KB
Attachments

Create an Attachment

Upload an attachment to a task or to a file type Custom Field.

Once a file has been uploaded to a custom_fields entity, use Set Custom Field Value to associate the uploaded file with a task.

To retrieve the ID of a Custom Field, you can use Get List Custom Fields or Get task.

post/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 or custom_fields for a Files Custom Field.

entity_idstring required

The ID of the task or Custom Field.

Response

The created attachment.

date_updatedinteger required

The date & time the attachment was updated (Unix epoch milliseconds timestamp).

date_createdinteger required

The date & time the attachment was created (Unix epoch milliseconds timestamp).

extensionstring required

The extension of the attachment.

idstring required

The ID of the attachment.

mime_typestring required

The MIME type of the attachment.

parent_entity_type'attachments' | 'comments' | 'custom_fields' | 'docs' | 'posts' | 'reminders' | 'tasks' | 'widgets' | 'views' required

The type of entity the attachment belongs to.

parent_idstring required

The ID of the entity the attachment belongs to.

sizeinteger required

The size in bytes of the attachment.

signedboolean required

The signed status of the attachment.

thumbnail_smallstring uri required

The small size thumbnail url of the attachment.

thumbnail_mediumstring uri required

The medium size thumbnail url of the attachment.

thumbnail_largestring uri required

The large size thumbnail url of the attachment.

titlestring required

The attachment title.

urlstring uri required

The url of the attachment.

user_idinteger required

The ID of the user who created the attachment.

Example response

{
  "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"
}