Get Files

Purpose

To fetch a file using its encrypted ID.

Endpoints

GET /files

Request Details

Request URL

{api-domain}/crm/{version}/files

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Scope

scope=ZohoCRM.Files.{operation_type}

Possible operation types

READ - To retrieve files from ZFS

Parameters

idstring, mandatory
The encrypted ID of the file you received in the response while uploading files to ZFS.

Possible Errors

NO_CONTENTHTTP 204
No content found
Resolution: Specify a valid value to the "id" parameter.
REQUIRED_PARAM_MISSINGHTTP 400
The expected parameter is missing
Resolution: Specify the required "id" parameter.
INVALID_REQUEST_METHODHTTP 400
The http request method type is not a valid one
Resolution: You have specified an invalid HTTP method to access the API URL. Specify a valid request method. Refer to endpoints section above.
AUTHORIZATION_FAILEDHTTP 400
User does not have sufficient privilege to read.
Resolution: The user does not have the permission to read files. Contact your system administrator.
OAUTH_SCOPE_MISMATCHHTTP 401
Unauthorized
Resolution: Client does not have ZohoCRM.Files.READ scope. Create a new client with valid scope. Refer to scope section above.
NO_PERMISSIONHTTP 403
Permission denied to read
Resolution: The user does not have permission to read files. Contact your system administrator.
INVALID_URL_PATTERNHTTP 404
Please check if the URL trying to access is a correct one
Resolution: The request URL specified is incorrect. Specify a valid request URL. Refer to request URL section above.
INTERNAL_ERRORHTTP 500
Internal Server Error
Resolution: Unexpected and unhandled exception in Server. Contact support team.

Sample Request

Curl Deluge

Copiedcurl "https://www.zohoapis.com/crm/v7/files?id=2cceafa194dxxxxxxxx4a20ed2"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"

Copiedresponse = invokeurl
[
	url: "https://www.zohoapis.com/crm/v7/files?id=2cceafa194dxxxxxxxx4a20ed2"
	type: GET
	connection:"crm_oauth_connection"
];
info response;