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?1759464180",
"thumb": "https://files-test.productive.io/attachments/files/000/000/001/thumb/img.png?1759464180",
"temp_url": "https://files-test.productive.io/attachments/files/000/000/001/original/img.png?1759464180",
"resized": false,
"created_at": "2025-10-03T06:03:00.855+02:00",
"deleted_at": null,
"attachment_type": null,
"message_id": null,
"external_id": null,
"attachable_type": "comment"
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "12"
}
},
"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?1759464180",
"thumb": "https://files-test.productive.io/attachments/files/000/000/002/thumb/img.png?1759464180",
"temp_url": "https://files-test.productive.io/attachments/files/000/000/002/original/img.png?1759464180",
"resized": false,
"created_at": "2025-10-03T06:03:00.963+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
}
}
}
},
"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-10-03T06:03:01.034+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": "eyJleHBpcmF0aW9uIjoiMjAyNS0xMC0wM1QwNTowMzowMVoiLCJjb25kaXRpb25zIjpbeyJidWNrZXQiOiJwcm9kdWN0aXZlLWZpbGVzLXRlc3QifSx7ImtleSI6ImF0dGFjaG1lbnRzL2ZpbGVzLzAwMC8wMDAvMDA0L29yaWdpbmFsL2ltZy5wbmcifSx7InN1Y2Nlc3NfYWN0aW9uX3N0YXR1cyI6IjIwMSJ9LFsiY29udGVudC1sZW5ndGgtcmFuZ2UiLDAsMzE0NTcyODAwXSx7IngtYW16LWNyZWRlbnRpYWwiOiJBU0lBUUdHUTQ2V1ZNTFFDWUxLQi8yMDI1MTAwMy9ldS13ZXN0LTEvczMvYXdzNF9yZXF1ZXN0In0seyJ4LWFtei1hbGdvcml0aG0iOiJBV1M0LUhNQUMtU0hBMjU2In0seyJ4LWFtei1kYXRlIjoiMjAyNTEwMDNUMDQwMzAxWiJ9LHsieC1hbXotc2VjdXJpdHktdG9rZW4iOiJGd29HWlhJdllYZHpFTFgvLy8vLy8vLy8vd0VhRFBBUFYwRndCQnRwaHdHdXR5TE9BNElaT2JFNEFLRVZWYVhVMnUvdnI1Nk90TDBnSUhnYnN6VVpMZVFlMTN5MWVaVzNNd0plRkJUbjJMVFYvVWZyS1VBRkZ3TlUvRFBSV0xGdHppaEVYSmdJMHl2d3BvNlROTlNlRlFlWHNSejQ1bU9xV1hueGZpUzNuVzhBYW1uRDlqT0J0N1l5a2U1YXlOVkljYmtvVU9kQk1McmtMNVRGVTFCOEMzSmNtMjhoZ2FqYllVTWNWd1N6U1U5QUcrcUM1YlloUlVpaU1PdnFFKzJhZ0FWc2k0ZXp3U0MyYnFsR1NiQm1BU0plVzBYN0gxdDJibXZITGRGY2pRS2xFdzJ4N1RFMG96Q0tjL0pZb2hya25hYkRNN2Jvck5HeXRkN08yWFNsVnlETE5PMTNXVnpxeXRQWEtuWDBDcSszVmZSanRtOXhFclYwc09EWm5nM1ZidE5pOTRTQ0wyWGNHNmpaVjFnSGtkZy9teDNrdEw0cjlWT0JpQ0dqUWlUUWZDemxEL3FzQkxGbGFpMWlZTXlIZUwxQjZsWlE4WnROcnh1NnpyWlI0UHoxUk5JeUtrNjA2VzdUbkFLc3E5dWpuMkFBOUNWRmtJQlozQXo2clhwVVdkMW5PbUpRWDBDVVpGbmFyWmZNNk5nekRqdEQ3blh3SmphSUdETUxHU3VZM25ER2JWaEZPaWZ6cmFqL3hOYXBta2pVWFlqNmJ5ZUQ2cGV3czkvRlFQQk9MZVRwR1EvVmJUeVZIMzM0ZURzUzB5eStlWldzR0RMVnBBMVNFRzYzTVlMM2FOQWlQa2RjUDlGMCtSS2x0ajFSTmlqd2xQM0dCaklsOVZHNVYwZ3RjYXVKUlBJWnFTc1gzZFhxWlRUWlhaeTRFYUV4aEZVbHVWL0RKcGRibXc9PSJ9XX0=",
"x-amz-credential": "ASIAQGGQ46WVMLQCYLKB/20251003/eu-west-1/s3/aws4_request",
"x-amz-algorithm": "AWS4-HMAC-SHA256",
"x-amz-date": "20251003T040301Z",
"x-amz-security-token": "FwoGZXIvYXdzELX//////////wEaDPAPV0FwBBtphwGutyLOA4IZObE4AKEVVaXU2u/vr56OtL0gIHgbszUZLeQe13y1eZW3MwJeFBTn2LTV/UfrKUAFFwNU/DPRWLFtzihEXJgI0yvwpo6TNNSeFQeXsRz45mOqWXnxfiS3nW8AamnD9jOBt7Yyke5ayNVIcbkoUOdBMLrkL5TFU1B8C3Jcm28hgajbYUMcVwSzSU9AG+qC5bYhRUiiMOvqE+2agAVsi4ezwSC2bqlGSbBmASJeW0X7H1t2bmvHLdFcjQKlEw2x7TE0ozCKc/JYohrknabDM7borNGytd7O2XSlVyDLNO13WVzqytPXKnX0Cq+3VfRjtm9xErV0sODZng3VbtNi94SCL2XcG6jZV1gHkdg/mx3ktL4r9VOBiCGjQiTQfCzlD/qsBLFlai1iYMyHeL1B6lZQ8ZtNrxu6zrZR4Pz1RNIyKk606W7TnAKsq9ujn2AA9CVFkIBZ3Az6rXpUWd1nOmJQX0CUZFnarZfM6NgzDjtD7nXwJjaIGDMLGSuY3nDGbVhFOifzraj/xNapmkjUXYj6byeD6pews9/FQPBOLeTpGQ/VbTyVH334eDsS0yy+eZWsGDLVpA1SEG63MYL3aNAiPkdcP9F0+RKltj1RNijwlP3GBjIl9VG5V0gtcauJRPIZqSsX3dXqZTTZXZy4EaExhFUluV/DJpdbmw==",
"x-amz-signature": "dd4b5df49463e2a3df3f3d205ac5ca890e20c45a25c9dad857685be984518634"
}
},
"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": {}
}
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?1759464181",
"thumb": "https://files-test.productive.io/attachments/files/000/000/008/thumb/img.png?1759464181",
"temp_url": "https://s3.amazonaws.com/infinum.productive.test/uploads/1418301662608/dummyfile.pdf",
"resized": false,
"created_at": "2025-10-03T06:03:01.260+02:00",
"deleted_at": null,
"attachment_type": null,
"message_id": null,
"external_id": null,
"attachable_type": "comment"
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "18"
}
},
"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 03 Oct 2025