Files and Attachments APIs
Attachments provide more information about a contact or a company, which normally cannot be displayed. You may also need to send images, text files, videos, or any other type of file to your contacts. The files and attachments API allows you to get a list of attachments, and to upload or download a photo or a file.
Get list of Attachments
Purpose
To get the list of attachments associated with a record in Zoho CRM.
Endpoints
- GET /{module_api_name}/{record_ID}/Attachments
Request Details
Request URL
{api-domain}/crm/{version}/{module_api_name}/{record_id}/Attachments
Supported modules
Leads, Accounts, Contacts, Deals, Campaigns, Tasks, Cases, Events, Calls, Solutions, Products, Vendors, Price Books, Quotes, Sales Orders, Purchase Orders, Invoices, Custom, Appointments, Services and Notes
Header
Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
Scope
ZohoCRM.modules.ALL
(or)
ZohoCRM.modules.{module_name}.{operation_type}
(and)
ZohoCRM.modules.attachments.{operation_type}
Possible module names
leads, accounts, contacts, deals, campaigns, tasks, cases, events, calls, solutions, products, vendors, pricebooks, quotes, salesorders, purchaseorders, invoices, custom, appointments, services and notes
Possible operation types
ALL - Full access to attachments
READ - Get attachment data
Parameters
- fieldsstring, mandatory
Specify the API name of the field whose details you want to receive in the response.
Sample Request
Copiedcurl "https://www.zohoapis.com/crm/v8/Leads/4876876000000376008/Attachments?fields=id,Owner,File_Name,Created_Time,Parent_Id"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"Copiedresponse = invokeurl
[
url: "https://www.zohoapis.com/crm/v8/Leads/4876876000000376008/Attachments?fields=id,Owner,File_Name,Created_Time,Parent_Id"
type: GET
connection:"crm_oauth_connection"
];
info response;Response JSON Keys
- OwnerJSON object
Represents the owner of the record, including their name, ID, and email.
- Modified_Timestring
The date and time when the attachment was last modified.
- File_Namestring
Represents the name of the uploaded attachment.
- Created_Timestring
The date and time when the attachment was added to the record.
- Sizeinteger
The size of the attachment (in bytes).
- Parent_IdJSON object
Represents the name and ID of the parent record.
- $editableboolean
Represents if the user can edit the attachment.
Possible values:
- true: The user can edit the attachment.
- false: The user cannot edit the attachment.
- $file_idstring
Represents the unique file ID of the attachment stored in Zoho File System (ZFS).
- $se_modulestring
Represents the API name of the parent module (e.g., Leads, Deals, Contacts).
- Modified_ByJSON object
Represents the user who last modified the attachment (includes ID, name, and email).
- idstring
Represents the unique ID of the related record.
- Created_ByJSON object
Represents the name, ID, and email of the user who added the attachment to the record.
Possible Errors
- INVALID_REQUEST_METHODHTTP 400
The request method is incorrect.
Resolution: Use the HTTP POST method to make this API call. Any other request method will result in this error. - AUTHORIZATION_FAILEDHTTP 400
User does not have sufficient privilege to read attachments
Resolution: The user does not have the permission to read attachment details. Contact your system administrator. - REQUIRED_PARAM_MISSINGHTTP 400
One of the expected parameter is missing
Resolution: Specify the mandatory parameter. Refer to the Parameters section above for more details. - INVALID_MODULEHTTP 400
The module name given seems to be invalid
Resolution: You have specified an invalid module name or there is no tab permission, or the module could have been removed from the available modules. Specify a valid module API name. - INVALID_MODULEHTTP 400
The given module is not supported in API
Resolution: The modules such as Documents and Projects are not supported. Specify a valid module API name. - AUTHENTICATION_FAILUREHTTP 401
You have not authorized the API call with valid access token.
Resolution: Include a valid access token in the request header to authorize the API call. - OAUTH_SCOPE_MISMATCHHTTP 401
Unauthorized
Resolution: Create a new access token with valid scope. Refer to the scope section at the beginning of this page. - NO_PERMISSIONHTTP 403
Permission denied to read attachment details
Resolution: The user does not have permission to read attachment details. Contact your system administrator. - INVALID_URL_PATTERNHTTP 404
The request URL is incorrect.
Resolution: Specify a valid request URL. Refer to the request URL section at the beginning of this page for more details. - INTERNAL_ERRORHTTP 500
Unexpected and unhandled exception in the server.
Resolution: Contact the support team at support@zohocrm.com.
Sample Response
Copied{
"data": [
{
"Owner": {
"name": "Patricia Boyle",
"id": "4876876000000327001",
"email": "patricia.boyle@zohocorp.com"
},
"File_Name": "Image.jpg",
"Created_Time": "2022-04-21T10:27:41+05:30",
"Parent_Id": null,
"id": "4876876000001021001"
},
{
"Owner": {
"name": "Patricia Boyle",
"id": "4876876000000327001",
"email": "patricia.boyle@zohocorp.com"
},
"File_Name": "in23er.png",
"Created_Time": "2022-04-20T14:45:42+05:30",
"Parent_Id": null,
"id": "4876876000001015061"
}
],
"info": {
"per_page": 200,
"next_page_token": null,
"count": 2,
"page": 1,
"previous_page_token": null,
"page_token_expiry": null,
"more_records": false
}
}