attachments

5 endpoints at a glance

Method	Path	Summary
POST	/attachments	Upload
DELETE	/attachments/{attachment_id}	Delete Attachment
GET	/attachments/{attachment_id}/download	Download
PATCH	/attachments/{attachment_id}/meta	Patch Meta
GET	/attachments/for-entity	List For Entity

attachments

---

List For Entity

GET

/attachments/for-entity

Parameters

Header Parameters

authorization

Query Parameters

entity_type*

Type

string

Required

Valid values

"task""project""contact""event""company""deal""note""invoice""expense""personal_expense"

entity_id*

Type

string

Required

page

Type

integer

Default

1

limit

Type

integer

Default

50

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

GET

/attachments/for-entity

Playground

Headers

authorization

Variables

Key

Value

entity_type*

entity_id*

page

limit

Samples

---

Upload

POST

/attachments

Parameters

Header Parameters

authorization

Request Body

multipart/form-data

Valid values"task""project""contact""event""company""deal""note""invoice""expense""personal_expense"

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

POST

/attachments

Playground

Headers

authorization

Body

entity_type*

entity_id*

file*

Samples

---

Download

GET

/attachments/{attachment_id}/download

Stream the bytes.

disposition=inline lets the browser render the file in place (the
document viewer frames this URL) instead of offering a save dialog. The
default stays attachment so every existing download link behaves
exactly as before. Only previewable types may go inline — otherwise a
.docx would render as a wall of binary in an iframe.

Parameters

Header Parameters

authorization

Path Parameters

attachment_id*

Type

string

Required

Query Parameters

disposition

Type

string

Valid values

"attachment""inline"

Default

"attachment"

Responses

Successful Response

Content-Type

application/json

[

]

GET

/attachments/{attachment_id}/download

Playground

Headers

authorization

Variables

Key

Value

attachment_id*

disposition

Samples

---

Patch Meta

PATCH

/attachments/{attachment_id}/meta

Update the document metadata block.

Same permission rule as delete: the uploader always may, otherwise you
need edit rights on the owning entity.

Parameters

Header Parameters

authorization

Path Parameters

attachment_id*

Type

string

Required

Request Body

application/json

{

  

"title": "string",

  

"description": "string",

  

"doc_type": "string",

  

"doc_date": "string",

  

"tag_ids": [

  

  

"string"

  

],

  

"party_ref": {

  

  

"additionalProperties": "string"

  

},

  

"keep_until": "string"

}

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

PATCH

/attachments/{attachment_id}/meta

Playground

Headers

authorization

Variables

Key

Value

attachment_id*

Body

Samples

---

Delete Attachment

DELETE

/attachments/{attachment_id}

Parameters

Header Parameters

authorization

Path Parameters

attachment_id*

Type

string

Required

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

DELETE

/attachments/{attachment_id}

Playground

Headers

authorization

Variables

Key

Value

attachment_id*

Samples

---