Get a record's sharing

GET/{moduleApiName}/{recordId}/actions/share

Use it in a workflow

Add a step and choose the Zoho CRM connector.
Pick the Get a record's sharing action (under Records).
Fill in the fields below, then reference the result from later steps as {{getARecordSSharing.response.data}}.

Request

Path parameters

moduleApiNamestringrequired

Specify the API name of the module that owns the record. Refer to the [Get Modules API](modules.yaml#$.paths./settings/modules.get) for valid values.

recordIdstring (int64)required

Specify the unique ID of the record. Refer to the [Get Records API](record.yaml#$.paths./{module}.get) for valid values.

Query parameters

sharedTostring

Specify the unique ID of the user whose share entries you want to retrieve. When set, the response returns only the share entries for that user. Use the [Get Users API](users.yaml#$paths./users.get) to get the valid IDs for the users.

viewstring

Specify the level of detail to include in the response. **Possible values**: summary, manage.

One ofmanagesummary

approvedstring

Filters sharing records by approval status. - `true` - return only approved sharing entries - `false` - return only unapproved (pending) sharing entries - `both` - return all sharing entries regardless of approval status

One oftruefalseboth

current_userboolean

Specify whether to return only the share entries for the current user. When set to **true**, the response returns only the share entries for the user making the API call.

Response

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

sharearray<object>

Represents the list of share records.

shared_withobjectrequired3 fields

Represents the details of the entity (user, role, or group) with which the record is shared.

share_related_recordsbooleanrequired

Indicates whether the related records of the shared record are also shared with the entity.

shared_throughobjectrequired2 fields

Represents the details of the record through which sharing is granted, including its module.

shared_timestring (date-time)

Represents the date and time at which the record was shared, in ISO 8601 format.

permissionstringrequired

Represents the level of access granted to the entity for the shared record. **Possible values**: - read_only - read_write - full_access

One ofread_onlyread_writefull_access

shared_byobject3 fields

Represents the details of the user who shared the record.

typestringrequired

Represents the type of sharing applied to the record. **Possible values**: - private - public

One ofprivatepublic

json

{
  "share": [
    {
      "shared_with": {
        "name": "string",
        "id": "string",
        "type": "users"
      },
      "share_related_records": false,
      "shared_through": {
        "module": {
          "name": "string",
          "id": "string"
        },
        "id": "string"
      },
      "permission": "read_only",
      "type": "private",
      "shared_time": "2025-01-01T00:00:00Z",
      "shared_by": {
        "name": "string",
        "id": "string",
        "zuid": "string"
      }
    }
  ]
}

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

Was this page helpful?