Files and Attachments APIs

Attachments provide more information about a contact or a candidate, which normally cannot be displayed. You may also need to send images, text files or videos or any other type of files to contacts. The files and attachments API allows a user to get a list of attachments, upload or download a photo or a file.

Get list of Attachments

Purpose

To get the list of attachments.

Request URL

https://recruit.zoho.com/recruit/v2/{module_api_name}/{record_id}/Attachments

module_api_name - The API name of the module

record_id - The unique ID of the record

Supported modules
Candidates, Applications, Job Openings, Interviews, Clients, Contacts, Departments, Tasks, Events, Vendors, Campaigns, and Custom Modules

Request Method

GET

Scope

scope=ZohoRecruit.modules.all
(or)
scope=ZohoRecruit.modules.{module_name}.{operation_type}
(and)
scope=ZohoRecruit.modules.attachments.all

 
Possible module namesPossible operation types
candidate, application, jobopening, interview, client, contact, department, task, event, vendor, campaign, and custommoduleALL - Full access to attachments
READ - Get attachment data

Sample Request

Copiedcurl "https://recruit.zoho.com/recruit/v2/Candidates/1000000231009/Attachments"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"

Sample Response

Copied{
    "data": [
       {
            "id": "1000000030750",
            "Modified_By": "1000000028468",
            "Owner": "1000000028468",
            "Parent_Id": "1000000231009",
            "Created_Time": "2016-03-30 20:29:35",
            "Modified_Time": "2016-03-30 20:29:35",
            "$Created_By": "Patricia Boyle",
            "$Owner": "Patricia Boyle",
            "Created_By": "1000000028468",
            "File_Name": "Resume.docx",
            "$Modified_By": "Patricia Boyle",
            "Size": "985160"
        }
    ],
    "info": {
        "range": "1-1",
        "more_records": false
    }
}