Documents (Attachment) API Documentation

Attachment Base URL:

https://{tenant-domain}.agentcis.com/api/v2/attachments/{attachmentableType}/{attachmentableId}

Parameters:

- attachmentableType (path parameter): The type of entity (e.g. clien,applications=>document_checklis,task,partner`)

- attachmentableId (path parameter): The ID of the entity

per_page=10&page=1

{

  "data": [

  {

            "_links": {

                "preview": "https:\/\/demoagency.agentcisapp.com\/attachments\/3\/preview",

                "download": "https:\/\/demoagency.agentcisapp.com\/attachments\/3\/download"

            },

            "id": 3,

            "original_name": "John.docx",

            "type": "docx",

            "namespace": "default",

            "file_size": {

                "formatted": "11.56 KB",

                "actual": 11839

            },

            "meta": null,

            "created_at": "05-02-2018",

            "updated_at": "01-31-2019",

            "uploaded_by": []

        },

  ],

  "links": {

        "first": "http:\/\/demoagency.agentcisapp.com\/api\/v2\/attachments\/client\/5?page=1",

        "last": "http:\/\/demoagency.agentcisapp.com\/api\/v2\/attachments\/client\/5?page=1",

        "prev": null,

        "next": null

    },

    "meta": {

        "current_page": 1,

        "from": 1,

        "last_page": 1,

        "links": [

            {

                "url": null,

                "label": "« Previous",

                "active": false

            },

            {

   "url": "http:\/\/demoagency.agentcisapp.com\/api\/v2\/attachments\/client\/5?page=1",

                "label": "1",

                "active": true

            },

            {

                "url": null,

                "label": "Next »",

                "active": false

            }

        ],

        "path": "http:\/\/demoagency.agentcisapp.com\/api\/v2\/attachments\/client\/5",

        "per_page": "10",

        "to": 2,

        "total": 2

    }

}

{

  "documents": [] (binary)

}

Note: use body type as form-data and set key as file

{

    "uploadedFiles": [],

    "rejectedFiles": [

        {

            "original_name": “",

            "path":””,

            "type": "pdf",

            "description": "",

            "file_size": ,

            "namespace": "”,

            "givenName": ""

        }

    ]

}

{

    original_name: “John”,

}

{

    "data": {

        "id": 3,

        "original_name": "Johns.docx",

        "path": "uploads\/documents\/c099688968925528594d8e5a2d9f3aaf.docx",

        "type": "docx",

        "description": null,

        "uploader": null,

        "uploader_type": "user",

        "attachmentable_id": 5,

        "attachmentable_type": "client",

        "file_size": 11839,

        "created_at": "2018-05-02T01:29:07.000000Z",

        "updated_at": "2025-10-08T08:56:38.000000Z",

        "namespace": "default",

        "meta": null

    },

    "message": "You\u2019ve successfully saved your attachment\u2019s information."

}

{

     ids: [100, 101],

      _method: "delete"

}

{

    “deletedFile”:[],

    “rejectedFiles”:[]

 }