---
title: "Documents (Attachment) API Documentation"
description: "The Attachment API provides endpoints for managing file attachments across different entities in the system (clients, applications, tasks, partners, etc.). It supports polymorphic relationships, allowing attachments to be associated with various types of entities."
url: https://support.agentcis.com/en/articles/394-documents-attachment-api-documentation
collection: "API Documentation"
updated: 2026-09-07
language: en
---

# Documents (Attachment) API Documentation

The Attachment API provides endpoints for managing file attachments across different entities in the system (clients, applications, tasks, partners, etc.). It supports polymorphic relationships, allowing attachments to be associated with various types of entities.

<table data-id="2935345e-0cdc-4e7f-8c79-dc0d1e6f07ee" style="min-width: 25px;"><colgroup><col style="min-width: 25px;"></colgroup><tbody><tr><td colspan="1" rowspan="1" style="vertical-align: top; padding: 5pt; overflow: hidden; overflow-wrap: break-word; border-width: 1pt; border-style: solid; border-color: #000000;"><p data-id="1ae29184-803e-4bfb-bfb8-6b887b2b0340" style="text-align: justify;"><span style="color: rgb(0, 0, 0);"><strong>Attachment Base URL:</strong></span></p><p data-id="a100a73e-ec1d-4954-a0f7-e20b6ccf4524" style="text-align: justify;"><a target="_blank" rel="noopener noreferrer nofollow" class="linktype-link link" data-linktype="link"><span style="color: rgb(17, 85, 204);"><u>https://{tenant-domain}.agentcis.com/api/v2</u></span></a><span style="color: rgb(0, 0, 0);">/attachments/{attachmentableType}/{attachmentableId}</span></p><p data-id="6eec5cc0-b4f2-420d-81d8-3655dd57ac82" style="text-align: justify;"><span style="color: rgb(0, 0, 0);"><strong>Parameters:</strong></span></p><p data-id="9184e667-42bc-442e-b4ae-5ff1ee2be0ab" style="text-align: justify;"><span style="color: rgb(0, 0, 0);">- attachmentableType (path parameter): The type of entity (e.g. clien</span><code>,</code><span style="color: rgb(0, 0, 0);">applications=&gt;document_checklis</span><code>,</code><span style="color: rgb(0, 0, 0);">task</span><code>,</code><span style="color: rgb(0, 0, 0);">partner`)</span></p><p data-id="8fc5c655-2f39-4430-92cb-38c6de3ea147" style="text-align: justify;"><span style="color: rgb(0, 0, 0);">- attachmentableId (path parameter): The ID of the entity</span></p><p data-id="00db7f20-1697-4af4-b0a0-7ac9eecde63d" style="text-align: justify;"><span style="color: rgb(0, 0, 0);">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span></p></td></tr></tbody></table>

  
  
API Endpoints

## List Attachments 🔒

-   Endpoint:**{{Attachment Base URL}}**/
    
-   Method: GET
    
-   Description: Retrieves all documents for a specific entity type and ID  
    

Query String Parameters:

<table data-id="b00bc476-d73b-4cc7-a702-df2f5d722ed4" style="min-width: 25px;"><colgroup><col style="min-width: 25px;"></colgroup><tbody><tr><td colspan="1" rowspan="1" style="vertical-align: top; padding: 5pt; overflow: hidden; overflow-wrap: break-word; border-width: 1pt; border-style: solid; border-color: #000000;"><p data-id="8ac515ad-f18d-4728-a5ac-38ef83516871" style="text-align: justify;"><span style="color: rgb(0, 0, 0);">per_page=10&amp;page=1</span></p></td></tr></tbody></table>

  

### Response:

<table data-id="684c923a-15de-4acf-8de7-1d20bef79138" style="min-width: 25px;"><colgroup><col style="min-width: 25px;"></colgroup><tbody><tr><td colspan="1" rowspan="1" style="vertical-align: top; padding: 5pt; overflow: hidden; overflow-wrap: break-word; border-width: 1pt; border-style: solid; border-color: #000000;"><p data-id="47797ef1-7aeb-439c-8284-36f48bcfb436" style="text-align: justify;"><span style="color: rgb(0, 0, 0);">{</span></p><p data-id="95999eaf-0d22-4a80-afc4-0643dadfa598" style="text-align: justify;"><span style="color: rgb(0, 0, 0);">&nbsp;&nbsp;"data": [</span></p><p data-id="99bca30b-1611-487a-97df-bbfb905d2a78" style="text-align: justify;"><span style="color: rgb(0, 0, 0);">&nbsp;&nbsp;{</span></p><p data-id="c7061b40-330c-4b59-9899-d5d54d69b8f5" style="text-align: justify;"><span style="color: rgb(0, 0, 0);">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"_links": {</span></p><p data-id="277f68d6-c7ec-46e7-8fed-436ade2e8591" style="text-align: justify;"><span style="color: rgb(0, 0, 0);">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"preview": "https:\/\/</span><a target="_blank" rel="noopener noreferrer nofollow" class="linktype-link link" data-linktype="link" href="https://demoagency.agentcisapp.com"><span style="color: rgb(0, 0, 0);">demoagency.agentcisapp.com</span></a><span style="color: rgb(0, 0, 0);">\/attachments\/3\/preview",</span></p><p data-id="43d2cd51-dd87-4706-b6e6-0ee58a911feb" style="text-align: justify;"><span style="color: rgb(0, 0, 0);">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"download": "https:\/\/</span><a target="_blank" rel="noopener noreferrer nofollow" class="linktype-link link" data-linktype="link" href="https://demoagency.agentcisapp.com"><span style="color: rgb(0, 0, 0);">demoagency.agentcisapp.com</span></a><span style="color: rgb(0, 0, 0);">\/attachments\/3\/download"</span></p><p data-id="1abef1d7-36c8-4324-ab5a-ab886e8add12" style="text-align: justify;"><span style="color: rgb(0, 0, 0);">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},</span></p><p data-id="9f17876c-2a06-4224-821b-d0a7db1d5165" style="text-align: justify;"><span style="color: rgb(0, 0, 0);">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id": 3,</span></p><p data-id="d98ce9bc-bf65-481f-b411-7a9d41977720" style="text-align: justify;"><span style="color: rgb(0, 0, 0);">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"original_name": "John.docx",</span></p><p data-id="624261da-b93f-4353-91f5-f1b5597fbf49" style="text-align: justify;"><span style="color: rgb(0, 0, 0);">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"type": "docx",</span></p><p data-id="59aa9d11-e093-489f-a324-f647670098af" style="text-align: justify;"><span style="color: rgb(0, 0, 0);">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"namespace": "default",</span></p><p data-id="cf11c07c-d6a6-412f-93db-332c4f2e52fd" style="text-align: justify;"><span style="color: rgb(0, 0, 0);">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"file_size": {</span></p><p data-id="26ec744b-0a07-45d8-a41f-c8d7482a6d26" style="text-align: justify;"><span style="color: rgb(0, 0, 0);">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"formatted": "11.56 KB",</span></p><p data-id="4137fb5f-2c9a-4394-8b73-bf9122ef02ae" style="text-align: justify;"><span style="color: rgb(0, 0, 0);">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"actual": 11839</span></p><p data-id="69cc3868-1ac7-418e-aaed-4e6d463253b6" style="text-align: justify;"><span style="color: rgb(0, 0, 0);">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},</span></p><p data-id="4c82e1f7-069f-440e-b28e-8ddaee75f03f" style="text-align: justify;"><span style="color: rgb(0, 0, 0);">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"meta": null,</span></p><p data-id="0dd64268-9604-428d-8cdb-4a25a45588c9" style="text-align: justify;"><span style="color: rgb(0, 0, 0);">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"created_at": "05-02-2018",</span></p><p data-id="edd88286-393b-4957-b2fe-39fb219d9893" style="text-align: justify;"><span style="color: rgb(0, 0, 0);">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"updated_at": "01-31-2019",</span></p><p data-id="2fca9fb8-5349-473a-a263-aae98256774e" style="text-align: justify;"><span style="color: rgb(0, 0, 0);">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"uploaded_by": []</span></p><p data-id="00278de8-c880-4130-900f-273e60cc4817" style="text-align: justify;"><span style="color: rgb(0, 0, 0);">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},</span></p><p data-id="f3be1ce9-4387-455d-bf69-d10fc6558726"><br></p><p data-id="5747d722-4b4b-4dec-aaae-1d45454c5df4" style="text-align: justify;"><span style="color: rgb(0, 0, 0);">&nbsp;&nbsp;],</span></p><p data-id="e698289b-a5fb-4a2a-b829-3440ca5c21be" style="text-align: justify;"><span style="color: rgb(0, 0, 0);">&nbsp;&nbsp;"links": {</span></p><p data-id="595d1007-4a5c-4736-b835-b3debca66c7c" style="text-align: justify;"><span style="color: rgb(0, 0, 0);">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"first": "http:\/\/</span><a target="_blank" rel="noopener noreferrer nofollow" class="linktype-link link" data-linktype="link" href="https://demoagency.agentcisapp.com"><span style="color: rgb(0, 0, 0);">demoagency.agentcisapp.com</span></a><span style="color: rgb(0, 0, 0);">\/api\/v2\/attachments\/client\/5?page=1",</span></p><p data-id="70cd0386-8215-4718-9abe-cd81676502f2" style="text-align: justify;"><span style="color: rgb(0, 0, 0);">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"last": "http:\/\/</span><a target="_blank" rel="noopener noreferrer nofollow" class="linktype-link link" data-linktype="link" href="https://demoagency.agentcisapp.com"><span style="color: rgb(0, 0, 0);">demoagency.agentcisapp.com</span></a><span style="color: rgb(0, 0, 0);">\/api\/v2\/attachments\/client\/5?page=1",</span></p><p data-id="31b1ea64-62fa-456b-8351-6a07a5488f95" style="text-align: justify;"><span style="color: rgb(0, 0, 0);">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"prev": null,</span></p><p data-id="47d23a7e-309b-4718-a5e7-38ae02388951" style="text-align: justify;"><span style="color: rgb(0, 0, 0);">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"next": null</span></p><p data-id="771e1055-e6f0-4ee0-b372-c205f371ba65" style="text-align: justify;"><span style="color: rgb(0, 0, 0);">&nbsp;&nbsp;&nbsp;&nbsp;},</span></p><p data-id="f3e8f6c9-18f5-4190-8981-7f8d2cec420c" style="text-align: justify;"><span style="color: rgb(0, 0, 0);">&nbsp;&nbsp;&nbsp;&nbsp;"meta": {</span></p><p data-id="51ad5a5b-cc56-4b44-a2c4-f4764162b5ec" style="text-align: justify;"><span style="color: rgb(0, 0, 0);">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"current_page": 1,</span></p><p data-id="32ac975a-4d0a-4a3d-ba21-e5cf8a32428c" style="text-align: justify;"><span style="color: rgb(0, 0, 0);">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"from": 1,</span></p><p data-id="3b536300-653c-4c85-bae7-d6561d3ba0a0" style="text-align: justify;"><span style="color: rgb(0, 0, 0);">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"last_page": 1,</span></p><p data-id="160cbcb9-9cbd-4cd5-97c9-572178cd488b" style="text-align: justify;"><span style="color: rgb(0, 0, 0);">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"links": [</span></p><p data-id="7a8f157c-dd87-439f-a073-0c436db84b2a" style="text-align: justify;"><span style="color: rgb(0, 0, 0);">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{</span></p><p data-id="88da7d10-3073-41d1-b2a1-18adbfee0bd7" style="text-align: justify;"><span style="color: rgb(0, 0, 0);">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"url": null,</span></p><p data-id="e66799e1-ff7f-4dce-b51a-50fff826a6d7" style="text-align: justify;"><span style="color: rgb(0, 0, 0);">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"label": "&amp;laquo; Previous",</span></p><p data-id="9f9aa3c8-3eb8-46b1-9b6b-252c583c503a" style="text-align: justify;"><span style="color: rgb(0, 0, 0);">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"active": false</span></p><p data-id="660ae762-c4ca-4728-8143-517748ebd386" style="text-align: justify;"><span style="color: rgb(0, 0, 0);">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},</span></p><p data-id="996813ab-bc5f-4cdd-8226-f267850f8cb8" style="text-align: justify;"><span style="color: rgb(0, 0, 0);">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{</span></p><p data-id="78745313-137f-435b-8bfa-696fd0082d3b" style="text-align: justify;"><span style="color: rgb(0, 0, 0);">&nbsp;&nbsp;&nbsp;"url": "http:\/\/</span><a target="_blank" rel="noopener noreferrer nofollow" class="linktype-link link" data-linktype="link" href="https://demoagency.agentcisapp.com"><span style="color: rgb(0, 0, 0);">demoagency.agentcisapp.com</span></a><span style="color: rgb(0, 0, 0);">\/api\/v2\/attachments\/client\/5?page=1",</span></p><p data-id="ed52f5bf-6948-4134-ad74-adbf35332efe" style="text-align: justify;"><span style="color: rgb(0, 0, 0);">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"label": "1",</span></p><p data-id="fe50c42c-4765-4ce3-aeac-666195a024a0" style="text-align: justify;"><span style="color: rgb(0, 0, 0);">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"active": true</span></p><p data-id="54f5a4a8-ce8e-4d17-bec7-e380d031703b" style="text-align: justify;"><span style="color: rgb(0, 0, 0);">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},</span></p><p data-id="1182c762-ffb0-4889-a6e5-ffd225157eca" style="text-align: justify;"><span style="color: rgb(0, 0, 0);">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{</span></p><p data-id="441c3741-ee30-432d-9deb-e02404392705" style="text-align: justify;"><span style="color: rgb(0, 0, 0);">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"url": null,</span></p><p data-id="a356ee5f-a7db-45dd-ae06-44dfaabdfca8" style="text-align: justify;"><span style="color: rgb(0, 0, 0);">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"label": "Next &amp;raquo;",</span></p><p data-id="fbcf8983-0772-45ec-bf61-468872bcb2a9" style="text-align: justify;"><span style="color: rgb(0, 0, 0);">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"active": false</span></p><p data-id="cada8c40-538c-4aa2-a7ac-dfbdb613dc51" style="text-align: justify;"><span style="color: rgb(0, 0, 0);">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;}</span></p><p data-id="bee6268c-39ae-498c-a715-1636dacd0151" style="text-align: justify;"><span style="color: rgb(0, 0, 0);">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;],</span></p><p data-id="b5f9763e-5b34-4d42-9355-cff2c79e3e69" style="text-align: justify;"><span style="color: rgb(0, 0, 0);">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"path": "http:\/\/</span><a target="_blank" rel="noopener noreferrer nofollow" class="linktype-link link" data-linktype="link" href="https://demoagency.agentcisapp.com"><span style="color: rgb(0, 0, 0);">demoagency.agentcisapp.com</span></a><span style="color: rgb(0, 0, 0);">\/api\/v2\/attachments\/client\/5",</span></p><p data-id="5e13dbff-d440-48ba-a5df-ca6308ba9e1e" style="text-align: justify;"><span style="color: rgb(0, 0, 0);">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"per_page": "10",</span></p><p data-id="3c67093e-2f80-42da-b7bc-f9404932f893" style="text-align: justify;"><span style="color: rgb(0, 0, 0);">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"to": 2,</span></p><p data-id="12f22deb-cf7e-40ee-9309-739ff5c9fb48" style="text-align: justify;"><span style="color: rgb(0, 0, 0);">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"total": 2</span></p><p data-id="51025730-88f9-4207-ad5c-31d05cc18491" style="text-align: justify;"><span style="color: rgb(0, 0, 0);">&nbsp;&nbsp;&nbsp;&nbsp;}</span></p><p data-id="bbdde931-b8d0-4c99-aa2d-181558ceba32" style="text-align: justify;"><span style="color: rgb(0, 0, 0);">}</span></p></td></tr></tbody></table>

  

HTTP Status Codes:

\- `200 OK`: Success

\- `401 Unauthorized`: Invalid or missing authentication

\- `403 Forbidden`: Insufficient permissions

\- `404 Not Found`: Entity not found  

## Uploads Attachments 🔒

-   Endpoint: **{{Attachment Base URL}}**/
    
-   Method: POST
    
-   Description: Uploads documents for a specific entity type and ID  
    

### Payload:

<table data-id="d6099fc1-5854-419a-aeb6-c72c1528d609" style="min-width: 25px;"><colgroup><col style="min-width: 25px;"></colgroup><tbody><tr><td colspan="1" rowspan="1" style="vertical-align: top; padding: 5pt; overflow: hidden; overflow-wrap: break-word; border-width: 1pt; border-style: solid; border-color: #000000;"><p data-id="f347cc49-4b0f-4b13-ac51-83790761a4a9" style="text-align: justify;"><span style="color: rgb(0, 0, 0);">{</span></p><p data-id="0efcf7a9-f00f-4d4b-a27e-ff627e4775f2" style="text-align: justify;"><span style="color: rgb(0, 0, 0);">&nbsp;&nbsp;"documents": [] (binary)</span></p><p data-id="65d8d01d-1a91-4eed-8e6f-931cde3f7a43" style="text-align: justify;"><span style="color: rgb(0, 0, 0);">}</span></p><p data-id="e5f54b63-3f9a-4d95-a65d-2745006fbae1"><br></p><p data-id="b516bf6b-d397-4cca-9743-24d6d1c4b556" style="text-align: justify;"><span style="color: rgb(0, 0, 0);">Note: use body type as form-data and set key as file</span></p></td></tr></tbody></table>

### Response:

<table data-id="789a2a10-91ac-4c60-9857-72ca38b4265a" style="min-width: 25px;"><colgroup><col style="min-width: 25px;"></colgroup><tbody><tr><td colspan="1" rowspan="1" style="vertical-align: top; padding: 5pt; overflow: hidden; overflow-wrap: break-word; border-width: 1pt; border-style: solid; border-color: #000000;"><p data-id="267accd4-f48b-4987-a0df-2420573de9a1" style="text-align: justify;"><span style="color: rgb(0, 0, 0);">{</span></p><p data-id="1adbb514-52c7-4724-8eb6-7845f97a8f35" style="text-align: justify;"><span style="color: rgb(0, 0, 0);">&nbsp;&nbsp;&nbsp;&nbsp;"uploadedFiles": [],</span></p><p data-id="543a75c6-720e-424e-aedc-1561857c30f0" style="text-align: justify;"><span style="color: rgb(0, 0, 0);">&nbsp;&nbsp;&nbsp;&nbsp;"rejectedFiles": [</span></p><p data-id="220bbf9c-d994-4847-b2c9-b5bed319421d" style="text-align: justify;"><span style="color: rgb(0, 0, 0);">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{</span></p><p data-id="31913fa7-ef37-4a83-b669-868660e10359" style="text-align: justify;"><span style="color: rgb(0, 0, 0);">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"original_name": “",</span></p><p data-id="41569873-9a1e-4440-b8d7-fd7f204bc03a" style="text-align: justify;"><span style="color: rgb(0, 0, 0);">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"path":””,</span></p><p data-id="e4f10443-d8c7-4ab6-8b23-df4cd7a3b556" style="text-align: justify;"><span style="color: rgb(0, 0, 0);">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"type": "pdf",</span></p><p data-id="ececa44a-d340-40dd-8840-40bd19ada7c5" style="text-align: justify;"><span style="color: rgb(0, 0, 0);">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"description": "",</span></p><p data-id="89ff3e75-b54c-4bb4-82a6-7ca5fc8db876" style="text-align: justify;"><span style="color: rgb(0, 0, 0);">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"file_size": ,</span></p><p data-id="8c001b8e-53f0-4e4a-8147-04bdc6a8de00" style="text-align: justify;"><span style="color: rgb(0, 0, 0);">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"namespace": "”,</span></p><p data-id="3b5ac8b8-e5ae-41b5-a130-d5919b1c2aa7" style="text-align: justify;"><span style="color: rgb(0, 0, 0);">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"givenName": ""</span></p><p data-id="ce76b2ce-1755-4d4f-8b11-63e41a8b340a" style="text-align: justify;"><span style="color: rgb(0, 0, 0);">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;}</span></p><p data-id="945605e5-0939-4536-8837-f25bab4b4e07" style="text-align: justify;"><span style="color: rgb(0, 0, 0);">&nbsp;&nbsp;&nbsp;&nbsp;]</span></p><p data-id="e3260d75-3b0f-4501-85ad-837254e0bcbd" style="text-align: justify;"><span style="color: rgb(0, 0, 0);">}</span></p></td></tr></tbody></table>

  

### HTTP Status Codes:

\- `200 OK`: Success

\- `400 Bad Request`: Validation error

\- `401 Unauthorized`: Invalid or missing authentication

\- `403 Forbidden`: Insufficient permissions

\- `404 Not Found`: Entity not found

\- `413 Payload Too Large`: File size exceeds limit  

## Update Attachments 🔒

-   Endpoint: **{{Attachment Base URL}}**/
    
-   Method: PUT
    
-   Description: Updates documents for a specific entity type and ID  
    

### Payload:

<table data-id="db1998ca-fc74-4006-b857-eed1fe3397f3" style="min-width: 25px;"><colgroup><col style="min-width: 25px;"></colgroup><tbody><tr><td colspan="1" rowspan="1" style="vertical-align: top; padding: 5pt; overflow: hidden; overflow-wrap: break-word; border-width: 1pt; border-style: solid; border-color: #000000;"><p data-id="abee0221-3201-4e12-b653-f934e60b2a85" style="text-align: justify;"><span style="color: rgb(0, 0, 0);">{</span></p><p data-id="d011a258-caae-41b1-81ed-9af5d9add06b" style="text-align: justify;"><span style="color: rgb(0, 0, 0);">&nbsp;&nbsp;&nbsp;&nbsp;original_name: “John”,</span></p><p data-id="82c395e3-10c9-49c8-afd3-7d46222c62c7" style="text-align: justify;"><span style="color: rgb(0, 0, 0);">}</span></p></td></tr></tbody></table>

### Response:

<table data-id="19944d28-a6fa-45a7-bd75-8271421edd6f" style="min-width: 25px;"><colgroup><col style="min-width: 25px;"></colgroup><tbody><tr><td colspan="1" rowspan="1" style="vertical-align: top; padding: 5pt; overflow: hidden; overflow-wrap: break-word; border-width: 1pt; border-style: solid; border-color: #000000;"><p data-id="a8ab2e04-ebc7-4bd1-a90b-8a2f436e2c49" style="text-align: justify;"><span style="color: rgb(0, 0, 0);">{</span></p><p data-id="836f058a-768f-4890-bf2e-6fea83b8fcab" style="text-align: justify;"><span style="color: rgb(0, 0, 0);">&nbsp;&nbsp;&nbsp;&nbsp;"data": {</span></p><p data-id="5580551e-7662-48e4-8d7a-9195945b1be1" style="text-align: justify;"><span style="color: rgb(0, 0, 0);">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id": 3,</span></p><p data-id="09a4e55a-9427-4fc2-b65a-5520c79d37ec" style="text-align: justify;"><span style="color: rgb(0, 0, 0);">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"original_name": "Johns.docx",</span></p><p data-id="19d2206f-052c-4d92-a053-792e04b9b513" style="text-align: justify;"><span style="color: rgb(0, 0, 0);">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"path": "uploads\/documents\/c099688968925528594d8e5a2d9f3aaf.docx",</span></p><p data-id="5d3874c9-0416-4e22-84fe-ef3cb1b29bb0" style="text-align: justify;"><span style="color: rgb(0, 0, 0);">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"type": "docx",</span></p><p data-id="db4056e6-aede-4cb1-817f-138a1c0aef98" style="text-align: justify;"><span style="color: rgb(0, 0, 0);">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"description": null,</span></p><p data-id="44dbf5f9-ea21-4109-a9d8-2f8b5e7c08ae" style="text-align: justify;"><span style="color: rgb(0, 0, 0);">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"uploader": null,</span></p><p data-id="beafb3e6-67e5-46bf-8d74-e76a22b24119" style="text-align: justify;"><span style="color: rgb(0, 0, 0);">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"uploader_type": "user",</span></p><p data-id="e672de61-d6ea-485c-bb15-f4a168793607" style="text-align: justify;"><span style="color: rgb(0, 0, 0);">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"attachmentable_id": 5,</span></p><p data-id="8a0ab3b2-cc02-4ffa-81bd-3b60cd07f027" style="text-align: justify;"><span style="color: rgb(0, 0, 0);">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"attachmentable_type": "client",</span></p><p data-id="9bf224e1-1c76-4f87-95a4-87821eb95394" style="text-align: justify;"><span style="color: rgb(0, 0, 0);">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"file_size": 11839,</span></p><p data-id="f8d7c1bd-87f9-4842-842c-55eb0f353a29" style="text-align: justify;"><span style="color: rgb(0, 0, 0);">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"created_at": "2018-05-02T01:29:07.000000Z",</span></p><p data-id="ff33d733-b71b-430f-9e95-810493a8f70d" style="text-align: justify;"><span style="color: rgb(0, 0, 0);">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"updated_at": "2025-10-08T08:56:38.000000Z",</span></p><p data-id="d8f27c95-fdd3-4176-a31e-b3c47ba38db1" style="text-align: justify;"><span style="color: rgb(0, 0, 0);">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"namespace": "default",</span></p><p data-id="d398133a-ce3a-415f-a255-a0a226d92ec7" style="text-align: justify;"><span style="color: rgb(0, 0, 0);">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"meta": null</span></p><p data-id="a4861071-2a23-4486-ae68-f0b8667b884c" style="text-align: justify;"><span style="color: rgb(0, 0, 0);">&nbsp;&nbsp;&nbsp;&nbsp;},</span></p><p data-id="c87fb513-ca81-4bb6-b0c3-ffebf2fb9fd8" style="text-align: justify;"><span style="color: rgb(0, 0, 0);">&nbsp;&nbsp;&nbsp;&nbsp;"message": "You\u2019ve successfully saved your attachment\u2019s information."</span></p><p data-id="9c91b608-3f45-4f3c-b1a4-6f96890a5bee" style="text-align: justify;"><span style="color: rgb(0, 0, 0);">}</span></p></td></tr></tbody></table>

  

### HTTP Status Codes:

\- `200 OK`: Success

\- `400 Bad Request`: Validation error

\- `401 Unauthorized`: Invalid or missing authentication

\- `403 Forbidden`: Insufficient permissions

\- `404 Not Found`: Entity not found

### Show Attachment 🔒

-   Endpoint:**{{Base URL}}**/attachments/view/{attachmentId}/download
    
-   Method: GET
    
-   Description: Shows the details of the specific attachment.  
    

Response:

<table data-id="62da3d96-b81a-470f-9535-0d861daf58b1" style="min-width: 25px;"><colgroup><col style="min-width: 25px;"></colgroup><tbody><tr><td colspan="1" rowspan="1" style="vertical-align: top; padding: 5pt; overflow: hidden; overflow-wrap: break-word; border-width: 1pt; border-style: solid; border-color: #000000;"><p data-id="31ce3f8b-aa04-41d5-9796-f527db2e21e3" style="text-align: justify;"><span style="color: #000000;">{</span></p><p data-id="ec46e02a-d161-4fc7-967e-616796a78c8f" style="text-align: justify;"><span style="color: #000000;">&nbsp;&nbsp;&nbsp;</span><span style="color: #a31515;">"id"</span><span style="color: #000000;">: </span><span style="color: #098658;">12443</span><span style="color: #000000;">,</span></p><p data-id="36051a84-ea36-4ed6-ad09-ffc07dcf52bb" style="text-align: justify;"><span style="color: #000000;">&nbsp;&nbsp;&nbsp;</span><span style="color: #a31515;">"original_name"</span><span style="color: #000000;">: </span><span style="color: #0451a5;">"Your Agent Agreement with Nova Anglia College_Study Network Pty Ltd.pdf"</span><span style="color: #000000;">,</span></p><p data-id="e5aad4b6-f37e-40c8-baa1-24cfebf8f3f2" style="text-align: justify;"><span style="color: #000000;">&nbsp;&nbsp;&nbsp;</span><span style="color: #a31515;">"path"</span><span style="color: #000000;">: </span><span style="color: #0451a5;">"uploads/partner/attachments/a00fe21fb68725ade4bdbe845a9fd5a2.pdf"</span><span style="color: #000000;">,</span></p><p data-id="b17f6760-563f-4490-81d2-097becac1cda" style="text-align: justify;"><span style="color: #000000;">&nbsp;&nbsp;&nbsp;</span><span style="color: #a31515;">"type"</span><span style="color: #000000;">: </span><span style="color: #0451a5;">"pdf"</span><span style="color: #000000;">,</span></p><p data-id="cfafbe86-2f02-4bbb-9b6d-d1fb0369384a" style="text-align: justify;"><span style="color: #000000;">&nbsp;&nbsp;&nbsp;</span><span style="color: #a31515;">"file_size"</span><span style="color: #000000;">: </span><span style="color: #098658;">547967</span><span style="color: #000000;">,</span></p><p data-id="3b04a96e-aee3-4284-879c-deeae3e19781" style="text-align: justify;"><span style="color: #000000;">&nbsp;&nbsp;&nbsp;</span><span style="color: #a31515;">"description"</span><span style="color: #000000;">: </span><span style="color: #0451a5;">""</span><span style="color: #000000;">,</span></p><p data-id="eedbd1da-f183-4c60-a6fc-2c8cec6955b0" style="text-align: justify;"><span style="color: #000000;">&nbsp;&nbsp;&nbsp;</span><span style="color: #a31515;">"namespace"</span><span style="color: #000000;">: </span><span style="color: #0451a5;">"default"</span><span style="color: #000000;">,</span></p><p data-id="e2c1ab16-8cf3-4902-94e1-9be5a16ee86e" style="text-align: justify;"><span style="color: #000000;">&nbsp;&nbsp;&nbsp;</span><span style="color: #a31515;">"url"</span><span style="color: #000000;">: </span><span style="color: #0451a5;">"</span><a target="_blank" rel="noopener noreferrer nofollow" class="linktype-link link" data-linktype="link" href="https://agentcisapp.s3.ap-southeast-2.amazonaws.com/3ccc6d9e-927f-4d30-b667-2a24c82de576/uploads/partner/attachments/a00fe21fb68725ade4bdbe845a9fd5a2.pdf?response-content-disposition=attachment%3B%20filename%3D%22Your%20Agent%20Agreement%20with%20Nova%20Anglia%20College_Study%20Network%20Pty%20Ltd.pdf%22&amp;response-content-type=application%2Fpdf&amp;X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&amp;X-Amz-Algorithm=AWS4-HMAC-SHA256&amp;X-Amz-Credential=AKIAJDQV36DNJQCY2VQA%2F20260204%2Fap-southeast-2%2Fs3%2Faws4_request&amp;X-Amz-Date=20260204T082853Z&amp;X-Amz-SignedHeaders=host&amp;X-Amz-Expires=15&amp;X-Amz-Signature=94ab84fce1bb4480dcced3003f8796804a37b2731e75b67fc03d508cd87d8ee1"><span style="color: #0451a5;">https://agentcisapp.s3.ap-southeast-2.amazonaws.com/3ccc6d9e-927f-4d30-b667-2a24c82de576/uploads/partner/attachments/a00fe21fb68725ade4bdbe845a9fd5a2.pdf?response-content-disposition=attachment%3B%20filename%3D%22Your%20Agent%20Agreement%20with%20Nova%20Anglia%20College_Study%20Network%20Pty%20Ltd.pdf%22&amp;response-content-type=application%2Fpdf&amp;X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&amp;X-Amz-Algorithm=AWS4-HMAC-SHA256&amp;X-Amz-Credential=AKIAJDQV36DNJQCY2VQA%2F20260204%2Fap-southeast-2%2Fs3%2Faws4_request&amp;X-Amz-Date=20260204T082853Z&amp;X-Amz-SignedHeaders=host&amp;X-Amz-Expires=15&amp;X-Amz-Signature=94ab84fce1bb4480dcced3003f8796804a37b2731e75b67fc03d508cd87d8ee1</span></a><span style="color: #0451a5;">"</span><span style="color: #000000;">,</span></p><p data-id="f5573f45-f850-411d-8f57-16999e38d908" style="text-align: justify;"><span style="color: #000000;">&nbsp;&nbsp;&nbsp;</span><span style="color: #a31515;">"action"</span><span style="color: #000000;">: </span><span style="color: #0451a5;">"download"</span></p><p data-id="d6f6fe1a-2a3a-4302-be1e-04235bbaea1b" style="text-align: justify;"><span style="color: #000000;">&nbsp;}</span></p></td></tr></tbody></table>

HTTP Status Codes:

\- `200 OK`: Success  

## Delete Attachments 🔒

-   Endpoint:**{{Base URL}}**/attachments
    
-   Method: POST
    
-   Description: Deletes multiple documents.
    

### Payload:

<table data-id="f8e109bf-0b36-49eb-844d-ebfab67c0265" style="min-width: 25px;"><colgroup><col style="min-width: 25px;"></colgroup><tbody><tr><td colspan="1" rowspan="1" style="vertical-align: top; padding: 5pt; overflow: hidden; overflow-wrap: break-word; border-width: 1pt; border-style: solid; border-color: #000000;"><p data-id="79c92fe7-ae9e-47e7-86c6-9e51c87764d2" style="text-align: justify;"><span style="color: rgb(0, 0, 0);">{</span></p><p data-id="d90320a1-687e-4f88-9bd3-7aa1c5c9f7c8" style="text-align: justify;"><span style="color: rgb(0, 0, 0);">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;ids: [100, 101],</span></p><p data-id="cc78bd43-cdce-4dad-aa03-f82d7cfd0fcd" style="text-align: justify;"><span style="color: rgb(0, 0, 0);">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;_method: "delete"</span></p><p data-id="224fcbbc-b9c1-463e-a6b3-d68ac82476ad" style="text-align: justify;"><span style="color: rgb(0, 0, 0);">}</span></p></td></tr></tbody></table>

### Response:

<table data-id="897c0e59-f078-499a-95b8-6cf8a29aac2f" style="min-width: 25px;"><colgroup><col style="min-width: 25px;"></colgroup><tbody><tr><td colspan="1" rowspan="1" style="vertical-align: top; padding: 5pt; overflow: hidden; overflow-wrap: break-word; border-width: 1pt; border-style: solid; border-color: #000000;"><p data-id="a77c5eed-7141-4862-83a4-e84050ad5e13" style="text-align: justify;"><span style="color: rgb(0, 0, 0);">{</span></p><p data-id="e23fb8f7-c972-4768-b9e0-133e0bd326e0" style="text-align: justify;"><span style="color: rgb(0, 0, 0);">&nbsp;&nbsp;&nbsp;&nbsp;“deletedFile”:[],</span></p><p data-id="118c2ea5-53ef-46ec-b09b-e244c46a0734" style="text-align: justify;"><span style="color: rgb(0, 0, 0);">&nbsp;&nbsp;&nbsp;&nbsp;“rejectedFiles”:[]</span></p><p data-id="3cf01001-b322-45ea-ac71-9602236d578e" style="text-align: justify;"><span style="color: rgb(0, 0, 0);">&nbsp;}</span></p></td></tr></tbody></table>

  

### HTTP Status Codes:

\- `200 OK`: Success

\- `400 Bad Request`: Validation error

\- `401 Unauthorized`: Invalid or missing authentication

\- `403 Forbidden`: Insufficient permissions
