Attachments

The attachment object represents files such as images, PDFs and documents that can be assigned to other objects. These include, but are not limited, to tasks, comments, expenses and purchase orders. With attachments, users can provide relevant information, resources and additional context for related objects.

You can find more about attachments in our Help documentation: Working with attachments

For more details on how to work with attachment files through our API please refer to Working with attachments guide.

Attributes

attachable_type string
Response Request

The type of the parent entity this file is attached to (e.g. comment, expense, task).

attachment_type string
Response Request Enum

The attachment category type (e.g. file, image, document).

Enum Values (2 values)

  • attachment
  • inline
aws_policy object
Response

The AWS S3 presigned upload policy used for direct file uploads to object storage.

bill bill
Response

The bill this attachment is associated with.

bill_id integer
Request

ID of the bill (vendor invoice) this attachment is associated with.

booking_id integer
Request

ID of the booking this attachment is associated with.

comment comment
Response

The comment this attachment belongs to.

comment_id integer
Request Parameter `filter`

The ID of the comment this attachment belongs to.

company_id integer
Parameter `filter`

The ID of the company this attachment is associated with.

content_type object
Response Request

The MIME content type of this file (e.g. image/png, application/pdf).

created_at string
Response

Timestamp when this attachment was uploaded.

creator person
Response

The person who uploaded this attachment.

creator_id integer
Parameter `filter`

The ID of the person who uploaded this attachment.

deal deal
Response

The deal this attachment is associated with.

deleted_at string
Response

Timestamp when this attachment was soft-deleted. Null if not deleted.

document_style document style
Response

The document layout style applied when rendering this attachment as a PDF.

document_style_id integer
Request

ID of the document style this attachment is associated with.

document_type document type
Response

The document type template used for generating structured PDF documents from this attachment.

document_type_id integer
Request

ID of the document type this attachment is associated with.

email email
Response

The email this attachment was received from or sent with.

expense expense
Response

The expense this attachment is associated with (e.g. receipt or supporting document).

expense_id integer
Request

ID of the expense this attachment is associated with.

external_id integer
Response

The external system ID for this attachment, used when synced from an integration.

file_updated_at object
Request

Timestamp when the file content was last updated in storage.

full_query string
Parameter `filter`

Full-text search query context for this attachment.

fuzzy_dates string
Parameter `filter`

Fuzzy date tokens extracted from this attachment for search purposes.

fuzzy_people integer
Parameter `filter`

Fuzzy person references extracted from this attachment for search purposes.

id integer
Parameter `filter` Parameter `sort`

The unique identifier of this attachment.

invoice invoice
Response

The invoice this attachment is associated with.

invoice_id integer
Request

ID of the invoice this attachment is associated with.

jump_query string
Parameter `filter`

Jump-to search query context for navigating to this attachment.

message_id integer
Response

The email thread message ID this attachment belongs to.

name object
Response Request

The filename of the uploaded file.

notes_attachment boolean
Parameter `filter`

Whether this attachment is embedded in a notes or rich text field.

organization organization
Response

The organization this attachment belongs to.

page page
Response

The doc page this attachment is associated with.

page_id integer
Request Parameter `filter`

The ID of the doc page this attachment is associated with.

project_id integer
Parameter `filter`

The ID of the project this attachment is scoped to.

purchase_order purchase order
Response

The purchase order this attachment is associated with.

purchase_order_id integer
Request

ID of the purchase order this attachment is associated with.

resized boolean
Response

Whether resized image variants are available for this attachment.

size object
Response Request

The file size in bytes.

task task
Response

The task this attachment is associated with.

task_id integer
Request Parameter `filter`

The ID of the task this attachment is associated with.

temp_url object
Response Request

A temporary pre-signed URL for accessing the file, valid for a limited time.

thumb object
Response

URL of a thumbnail image for previewing this attachment (for image files).

type integer
Parameter `filter`

The attachment type identifier (e.g. file vs embedded image).

url object
Response

The download URL for this attachment.

widget_id integer
Request

ID of the widget this attachment is associated with.