Attachments APIs

Using the Attachments tab in the Details page of modules, users can store and access all relevant documents, images, and files related to a specific record.

List Attachments

Purpose

To fetch the list of all available attachments in a record.

Request URL

https://fsm.zoho.com/fsm/v1/<module_api_name>/<record_id>/Attachments

module_api_name - The API name of the module from whose record you want to fetch the attachments

record_id - The unique ID of the record.

Request Method

GET

Scope

scope=ZohoFSM.modules.<module_name>.READ

Supported Modules

Module Name	API Name
Requests	Requests
WorkOrders	Work_Orders
Estimates	Estimates
ServiceAppointments	Service_Appointments
Contacts	Contacts
Companies	Companies
Assets	Assets
Service_And_Parts	Service_And_Parts

Sample Request

Copiedcurl --request GET 'https://fsm.zoho.com/fsm/v1/Service_Appointments/1003000002206029/Attachments' \
--header 'Authorization: Zoho-oauthtoken 1000.xxxxxx.xxxxxxe'

Sample Response

Copied{
    "data": [
        {
            "Owner": {
                "name": "Marianne Sheehan",
                "id": "1003000000208001",
                "email": "marianne@noemail.com"
            },
            "Modified_Time": "2024-12-20T14:45:04+05:30",
            "File_Name": "Screenshot.png",
            "Created_Time": "2024-12-20T14:45:04+05:30",
            "Size": "53297",
            "Parent_Id": null,
            "$editable": true,
            "$file_id": "1734686039170sDbUhXRLX4VNu3SIyESlQg94H",
            "$permissions": {
                "read": true,
                "edit": true,
                "delete": true
            },
            "$type": null,
            "$se_module": "Service_Appointments",
            "Modified_By": {
                "name": "Marianne Sheehan",
                "id": "1003000000208001",
                "email": "marianne@noemail.com"
            },
            "$inactive": false,
            "id": "1003000002259046",
            "Parent_Record_Id": {
                "name": "AP-86",
                "id": "1003000002206029"
            },
            "Created_By": {
                "name": "Marianne Sheehan",
                "id": "1003000000208001",
                "email": "marianne@noemail.com"
            },
            "$link_url": null
        }
    ],
    "info": {
        "per_page": 200,
        "count": 1,
        "page": 1,
        "more_records": false
    }
}

Show full

Show less