Get Files

Purpose

To fetch a file uploaded to the Zoho File System, using its encrypted ID.

Endpoints

  • GET /files?id={file_ID}

Request Details

Request URL

{api-domain}/crm/{version}/files?id={file_ID}

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Scope

ZohoCRM.Files.{operation_type}

Possible operation types

READ - To retrieve files from ZFS

Parameters

Possible Errors

  • NO_CONTENTHTTP 204

    No content found
    Resolution: Specify a valid value for the "id" parameter.

  • REQUIRED_PARAM_MISSINGHTTP 400

    The expected parameter is missing 
    Resolution: Specify the required "id" parameter.

  • INVALID_REQUEST_METHODHTTP 400

    The request method is incorrect.
    Resolution: Use the HTTP PUT 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 get files.
    Resolution: Contact your system administrator.

  • OAUTH_SCOPE_MISMATCHHTTP 401

    Unauthorized
    Resolution: Client does not have ZohoCRM.Files.READ scope. Refer to the Scope section at the beginning of this page for the list of required scopes.

  • NO_PERMISSIONHTTP 403

    You do not have permission to update scoring rules.
    Resolution: The user does not have permission to update scoring rules. 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 Request

Copiedcurl "https://www.zohoapis.com/crm/v8/files?id=2cceafa194dxxxxxxxx4a20ed2"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
Copiedresponse = invokeurl
[
	url: "https://www.zohoapis.com/crm/v8/files?id=2cceafa194dxxxxxxxx4a20ed2"
	type: GET
	connection:"crm_oauth_connection"
];
info response;