Retrieve All Attachments

GET/{moduleApiName}/{recordId}/Attachments

Use it in a workflow

Add a step and choose the Zoho CRM connector.
Pick the Retrieve All Attachments action (under Attachments).
Fill in the fields below, then reference the result from later steps as {{retrieveAllAttachments.response.data}}.

Request

Path parameters

recordIdstringrequired

Specify the unique identifier of the record. Use the [Get Records API](record.yaml#$.paths./module.get) to retrieve record IDs.

moduleApiNamestringrequired

Specify the API name of the module (e.g., `Leads`, `Contacts`, `Accounts`). Use the [Get Modules API](modules.yaml#$.paths./settings/modules.get) to retrieve the module API names.

Query parameters

fieldsstring

Specify the fields to retrieve. Use the [Get Fields Metadata API](fields.yaml#$.paths./settings/fields.get) to retrieve the field IDs.

Response

Returns 200 with an object. Read it in later steps with {{retrieveAllAttachments.response.data.<field>}}.

dataarray<object>

Array of attachment objects

idstringrequired

Represents the unique numeric identifier of the attachment

File_Namestring

Represents the name of the attached file

Sizestring

Represents the size of the attachment in bytes

Created_Timestring (date-time)required

Represents the timestamp when the attachment was created (ISO 8601 with timezone)

Created_Byobjectrequired3 fields

User who created the attachment.

Modified_Timestring (date-time)required

Represents the timestamp when the attachment was last modified (ISO 8601 with timezone)

Modified_Byobjectrequired3 fields

User who last modified the attachment.

Ownerobject3 fields

Owner of the attachment

Parent_Idobject2 fields

Parent record information

$field_statesobject | null

Represents the field states metadata

$editableboolean

Indicates if the attachment is editable

$file_idstring | null

Represents the file identifier for the attachment

$typestring

Represents the type of the attachment. Possible values: `File` for uploaded files, or `Link URL` for URL-based attachments.

$se_modulestring

Represents the source module name

$statestring

Represents the current state of the attachment

$link_urlstring | null

Represents the URL for link-type attachments. Null for file attachments.

$sharing_permissionstring

Represents the sharing permission level for the attachment

infoobject

Pagination information for list responses

per_pageinteger (int32)required

Represents the number of records per page

next_page_tokenstring | nullrequired

Represents the token to retrieve the next page of results

countinteger (int32)required

Represents the number of records returned in the current response

pageinteger (int32)required

Represents the current page number

previous_page_tokenstring | nullrequired

Represents the token to retrieve the previous page of results

page_token_expirystring | nullrequired

Represents the expiry timestamp for the page tokens

more_recordsbooleanrequired

Indicates whether more records are available

json

{
  "data": [
    {
      "id": "string",
      "Created_Time": "2025-01-01T00:00:00Z",
      "Created_By": {
        "id": "string",
        "name": "string",
        "email": "name@example.com"
      },
      "Modified_Time": "2025-01-01T00:00:00Z",
      "Modified_By": {
        "id": "string",
        "name": "string",
        "email": "name@example.com"
      },
      "File_Name": "string",
      "Size": "string",
      "Owner": {
        "id": "string",
        "name": "string",
        "email": "name@example.com"
      },
      "Parent_Id": {
        "id": "string",
        "name": "string"
      },
      "$field_states": {},
      "$editable": false,
      "$file_id": "string"
    }
  ],
  "info": {
    "per_page": 0,
    "next_page_token": "string",
    "count": 0,
    "page": 0,
    "previous_page_token": "string",
    "page_token_expiry": "2025-01-01T00:00:00Z",
    "more_records": false
  }
}

Need more? See the Zoho CRM guide for connection setup and behaviour shared by every action.

Was this page helpful?