API Documentation
Attachments ¶
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.
Supported filter params
-
comment_id (array)
-
page_id (array)
-
task_id (array)
GET /api/v2/attachments?filter[comment_id]=3
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": [
{
"id": "1",
"type": "attachments",
"attributes": {
"name": "img.png",
"content_type": "image/png",
"size": 3479,
"url": "https://files-test.productive.io/attachments/files/000/000/001/original/img.png?1754020988",
"thumb": "https://files-test.productive.io/attachments/files/000/000/001/thumb/img.png?1754020988",
"temp_url": "https://files-test.productive.io/attachments/files/000/000/001/original/img.png?1754020988",
"resized": false,
"created_at": "2025-08-01T06:03:08.189+02:00",
"deleted_at": null,
"attachment_type": null,
"message_id": null,
"external_id": null,
"attachable_type": "comment"
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "13"
}
},
"creator": {
"meta": {
"included": false
}
},
"invoice": {
"meta": {
"included": false
}
},
"purchase_order": {
"meta": {
"included": false
}
},
"bill": {
"meta": {
"included": false
}
},
"email": {
"meta": {
"included": false
}
},
"page": {
"meta": {
"included": false
}
},
"expense": {
"meta": {
"included": false
}
},
"comment": {
"meta": {
"included": false
}
},
"task": {
"meta": {
"included": false
}
},
"document_style": {
"meta": {
"included": false
}
},
"document_type": {
"meta": {
"included": false
}
},
"deal": {
"meta": {
"included": false
}
}
}
}
],
"links": {
"first": "http://api-test.productive.io/api/v2/attachments?filter%5Bcomment_id%5D=3&page%5Bnumber%5D=1&page%5Bsize%5D=30",
"last": "http://api-test.productive.io/api/v2/attachments?filter%5Bcomment_id%5D=3&page%5Bnumber%5D=1&page%5Bsize%5D=30"
},
"meta": {
"current_page": 1,
"total_pages": 1,
"total_count": 1,
"page_size": 30,
"max_page_size": 200
}
}
Get attachmentsGET/api/v2/attachments
GET /api/v2/attachments/2
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "2",
"type": "attachments",
"attributes": {
"name": "img.png",
"content_type": "image/png",
"size": 3479,
"url": "https://files-test.productive.io/attachments/files/000/000/002/original/img.png?1754020988",
"thumb": "https://files-test.productive.io/attachments/files/000/000/002/thumb/img.png?1754020988",
"temp_url": "https://files-test.productive.io/attachments/files/000/000/002/original/img.png?1754020988",
"resized": false,
"created_at": "2025-08-01T06:03:08.302+02:00",
"deleted_at": null,
"attachment_type": null,
"message_id": null,
"external_id": null,
"attachable_type": "comment"
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "14"
}
},
"creator": {
"meta": {
"included": false
}
},
"invoice": {
"meta": {
"included": false
}
},
"purchase_order": {
"meta": {
"included": false
}
},
"bill": {
"meta": {
"included": false
}
},
"email": {
"meta": {
"included": false
}
},
"page": {
"meta": {
"included": false
}
},
"expense": {
"meta": {
"included": false
}
},
"comment": {
"meta": {
"included": false
}
},
"task": {
"meta": {
"included": false
}
},
"document_style": {
"meta": {
"included": false
}
},
"document_type": {
"meta": {
"included": false
}
},
"deal": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
Gets a attachmentGET/api/v2/attachments/{id}
- id
number
(required) Example: 1attachment id
POST /api/v2/attachments
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
"data": {
"type": "attachments",
"attributes": {
"name": "img.png",
"attachable_id": 5,
"attachable_type": "comment"
}
}
}
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "4",
"type": "attachments",
"attributes": {
"name": "img.png",
"content_type": null,
"size": null,
"url": "https://files-test.productive.io/attachments/files/000/000/004/original/img.png",
"thumb": null,
"temp_url": null,
"resized": false,
"created_at": "2025-08-01T06:03:08.367+02:00",
"deleted_at": null,
"attachment_type": null,
"message_id": null,
"external_id": null,
"attachable_type": "comment",
"aws_policy": {
"key": "attachments/files/000/000/004/original/img.png",
"success_action_status": "201",
"policy": "eyJleHBpcmF0aW9uIjoiMjAyNS0wOC0wMVQwNTowMzowOFoiLCJjb25kaXRpb25zIjpbeyJidWNrZXQiOiJwcm9kdWN0aXZlLWZpbGVzLXRlc3QifSx7ImtleSI6ImF0dGFjaG1lbnRzL2ZpbGVzLzAwMC8wMDAvMDA0L29yaWdpbmFsL2ltZy5wbmcifSx7InN1Y2Nlc3NfYWN0aW9uX3N0YXR1cyI6IjIwMSJ9LFsiY29udGVudC1sZW5ndGgtcmFuZ2UiLDAsMzE0NTcyODAwXSx7IngtYW16LWNyZWRlbnRpYWwiOiJBU0lBUUdHUTQ2V1ZQSEZRWk5TNy8yMDI1MDgwMS9ldS13ZXN0LTEvczMvYXdzNF9yZXF1ZXN0In0seyJ4LWFtei1hbGdvcml0aG0iOiJBV1M0LUhNQUMtU0hBMjU2In0seyJ4LWFtei1kYXRlIjoiMjAyNTA4MDFUMDQwMzA4WiJ9LHsieC1hbXotc2VjdXJpdHktdG9rZW4iOiJGd29HWlhJdllYZHpFTTMvLy8vLy8vLy8vd0VhREtWMzR4R2JVQ08xaVc1MnV5TE9BOUJtbERFNGJvbDhLZEdPcFNSQVA1VFRkUFlmaVRJYnBIcHdKRnJ0azdzME5JcTBCOTRFUUdxTUlGVGcrOWx0a002S0E4NzR1RktRYnA1M0k0NkoxRk1FQTNhdzVtTndwMDVmWVBKSnhXZWFuVDd4NE5Wd1FCd09ibHpBa2NkTDdLNytmNjJPMzhJVm1mQkJ5NlRHSVNTdlNac3N0engxOGlZK1hXWEtHUUgyR3k0ZXVvRUFLNGRGZHVmcnJXSll4dWZadXQ5clVrLzV2ZkpQZlVyQit2Vk9wMlFZWUdsTU1lZHBBV2NaVHZVSEtWV0V2VzJzWHIzWlFOODRpOGxQSE96WmREaWlVaXBMMjh5SWtSei9kelZ3cFJYS1Z0NjBIRjZBR2M2OGFIK014VzBZM2h6MDZ1cG9XNlFRd1VabTVLT2xGUGl0cW1ZRHBqZWxQQ2xmNUxicU5mOVkrTVNqUXVpZklBZWtRY0JvZ3JVS0swUStUcUFsQ1lXTTVXclJZakxJZjMvTW1rVGVZUlRveEFleGtZQ2RqSnlyUUpYajZlKzdnWm1KcHZ1WHh2R1habzI5ZXFhdmFCd1psWEhBZUdWOTFJOTZOcTBZZFJaazdYQloyMDhDZVZVQlRkSnlKSk94RUwvdHlHeW9jZ2ptT3dxN0EyOFZMQWpnUVNjL2I2WWMwVTdtTmtaVjI5N3Q5Nks4VkxHOURMM3pYaTc4Nk5hb2FTMmV5QW45VEJyTEZ4TWxTdzB3ZE00YUhQRWpaNWt0YlI1bTQzYmRpYVFhZGtzekVseEdjU3dMY0JkZTRYZnFwcnBXSXlqOTk3REVCaklsRnhhVm1lcHh4L3N0S0xoWC81WVV2UFJjK3MrUy91cjRDVm01cnJIcmNWdS9LcWFGWUE9PSJ9XX0=",
"x-amz-credential": "ASIAQGGQ46WVPHFQZNS7/20250801/eu-west-1/s3/aws4_request",
"x-amz-algorithm": "AWS4-HMAC-SHA256",
"x-amz-date": "20250801T040308Z",
"x-amz-security-token": "FwoGZXIvYXdzEM3//////////wEaDKV34xGbUCO1iW52uyLOA9BmlDE4bol8KdGOpSRAP5TTdPYfiTIbpHpwJFrtk7s0NIq0B94EQGqMIFTg+9ltkM6KA874uFKQbp53I46J1FMEA3aw5mNwp05fYPJJxWeanT7x4NVwQBwOblzAkcdL7K7+f62O38IVmfBBy6TGISSvSZsstzx18iY+XWXKGQH2Gy4euoEAK4dFdufrrWJYxufZut9rUk/5vfJPfUrB+vVOp2QYYGlMMedpAWcZTvUHKVWEvW2sXr3ZQN84i8lPHOzZdDiiUipL28yIkRz/dzVwpRXKVt60HF6AGc68aH+MxW0Y3hz06upoW6QQwUZm5KOlFPitqmYDpjelPClf5LbqNf9Y+MSjQuifIAekQcBogrUKK0Q+TqAlCYWM5WrRYjLIf3/MmkTeYRToxAexkYCdjJyrQJXj6e+7gZmJpvuXxvGXZo29eqavaBwZlXHAeGV91I96Nq0YdRZk7XBZ208CeVUBTdJyJJOxEL/tyGyocgjmOwq7A28VLAjgQSc/b6Yc0U7mNkZV297t96K8VLG9DL3zXi786NaoaS2eyAn9TBrLFxMlSw0wdM4aHPEjZ5ktbR5m43bdiaQadkszElxGcSwLcBde4XfqprpWIyj997DEBjIlFxaVmepxx/stKLhX/5YUvPRc+s+S/ur4CVm5rrHrcVu/KqaFYA==",
"x-amz-signature": "16d6126887b4d5401bacbfe91333897e3198319c59a3717e65339ff18f4d1d31"
}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "15"
}
},
"creator": {
"meta": {
"included": false
}
},
"invoice": {
"meta": {
"included": false
}
},
"purchase_order": {
"meta": {
"included": false
}
},
"bill": {
"meta": {
"included": false
}
},
"email": {
"meta": {
"included": false
}
},
"page": {
"meta": {
"included": false
}
},
"expense": {
"meta": {
"included": false
}
},
"comment": {
"meta": {
"included": false
}
},
"task": {
"meta": {
"included": false
}
},
"document_style": {
"meta": {
"included": false
}
},
"document_type": {
"meta": {
"included": false
}
},
"deal": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
POST /api/v2/attachments
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
"data": {
"type": "attachments",
"attributes": {
"attachable_type": ""
}
}
}
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"errors": [
{
"status": "422",
"code": "invalid_attribute",
"title": "Invalid Attribute",
"detail": "can't be blank",
"source": {
"pointer": "data/attributes/name"
}
},
{
"status": "422",
"code": "invalid_attribute",
"title": "Invalid Attribute",
"detail": "is not included in the list",
"source": {
"pointer": "data/attributes/attachable_type"
}
}
]
}
POST /api/v2/attachments
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
"data": {
"type": "attachments",
"attributes": {
"name": "img.png",
"attachable_id": 7,
"attachable_type": "comment",
"size": 315621376
}
}
}
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"errors": [
{
"status": "422",
"code": "invalid_attribute",
"title": "Invalid Attribute",
"detail": "must be less than or equal to 314572800",
"source": {
"pointer": "data/attributes/size"
}
}
]
}
POST /api/v2/attachments
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
"data": {
"type": "attachments",
"attributes": {
"name": "img.png",
"attachable_id": 8,
"attachable_type": "comment",
"content_type": "application/x-msdownload"
}
}
}
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"errors": [
{
"status": "422",
"code": "invalid_attribute",
"title": "Invalid Attribute",
"detail": "is reserved",
"source": {
"pointer": "data/attributes/content_type"
}
}
]
}
Create a attachmentPOST/api/v2/attachments
- name
string
(required) Example: namename
- id
string
(required) Example: Commentattachable_type
PATCH /api/v2/attachments/8
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
"data": {
"type": "attachments",
"attributes": {
"temp_url": "https://s3.amazonaws.com/infinum.productive.test/uploads/1418301662608/dummyfile.pdf"
}
}
}
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "8",
"type": "attachments",
"attributes": {
"name": "img.png",
"content_type": "image/png",
"size": 3479,
"url": "https://files-test.productive.io/attachments/files/000/000/008/original/img.png?1754020988",
"thumb": "https://files-test.productive.io/attachments/files/000/000/008/thumb/img.png?1754020988",
"temp_url": "https://s3.amazonaws.com/infinum.productive.test/uploads/1418301662608/dummyfile.pdf",
"resized": false,
"created_at": "2025-08-01T06:03:08.601+02:00",
"deleted_at": null,
"attachment_type": null,
"message_id": null,
"external_id": null,
"attachable_type": "comment"
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "19"
}
},
"creator": {
"meta": {
"included": false
}
},
"invoice": {
"meta": {
"included": false
}
},
"purchase_order": {
"meta": {
"included": false
}
},
"bill": {
"meta": {
"included": false
}
},
"email": {
"meta": {
"included": false
}
},
"page": {
"meta": {
"included": false
}
},
"expense": {
"meta": {
"included": false
}
},
"comment": {
"meta": {
"included": false
}
},
"task": {
"meta": {
"included": false
}
},
"document_style": {
"meta": {
"included": false
}
},
"document_type": {
"meta": {
"included": false
}
},
"deal": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
PATCH /api/v2/attachments/9
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
"data": {
"type": "attachments",
"attributes": {
"attachable_type": ""
}
}
}
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"errors": [
{
"status": "422",
"code": "invalid_attribute",
"title": "Invalid Attribute",
"detail": "is not included in the list",
"source": {
"pointer": "data/attributes/attachable_type"
}
}
]
}
Update a attachmentPATCH/api/v2/attachments/{id}
- id
number
(required) Example: 1attachment id
DELETE /api/v2/attachments/10
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Deletes a attachmentDELETE/api/v2/attachments/{id}
- id
number
(required) Example: 1attachment id
Generated by aglio on 01 Aug 2025