> ## Documentation Index
> Fetch the complete documentation index at: https://deepline.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Zoho CRM: Record Locking Configurations Get Record Locking Configuration

> Get the record locking setup of a Zoho CRM module, showing when records lock and who can edit them. Includes SDK V2 examples, schemas, and cost.

Get the record locking setup of a Zoho CRM module, showing when records lock and who can edit them.

> [!NOTE]
>
> Tool ID: `zoho_crm_record_locking_configurations_get_record_locking_configuration`

## Run this action

Use the TypeScript SDK for one call. Use `ctx.tools.execute(...)` inside a Play for durable calls, scheduled calls, or CSV processing.

```ts theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'zoho_crm_record_locking_configurations_get_record_locking_configuration',
  {
    "module": "example"
  },
);

console.log(result.toolResponse.raw);
```

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute zoho_crm_record_locking_configurations_get_record_locking_configuration --input '{
  "module": "example"
}' --json
```

## Example response

The static output schema lacks the details for a reliable example. Use `deepline describe zoho_crm_record_locking_configurations_get_record_locking_configuration --json` for the complete live contract.

## Input reference

To retrieve the record locking configuration for different modules.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.module` | `string` | Yes | — | The API name of the module for which the record locking configuration is to be retrieved. Maximum length: 256. |

<details>
  <summary>Show raw input schema</summary>

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "To retrieve the record locking configuration for different modules.",
    "properties": {
      "module": {
        "type": "string",
        "description": "The API name of the module for which the record locking configuration is to be retrieved.",
        "maxLength": 256
      }
    },
    "required": [
      "module"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | A JSON object containing the record locking configuration details for the module. |
| `result.data.record_locking_configurations` | `array` | Yes | — | List of record locking configuration details for the module. Maximum items: 1. |
| `result.data.record_locking_configurations[].lock_type` | `"automatic" \| "manual" \| "both"` | Yes | — | The type of locking applied to the records. Allowed: `automatic`, `manual`, `both`. |
| `result.data.record_locking_configurations[].locked_for` | `"all_profiles" \| "all_profiles_except_excluded_profiles"` | Yes | — | Specifies whether the records are locked for all profiles or all profiles except the excluded profiles. Allowed: `all_profiles`, `all_profiles_except_excluded_profiles`. |
| `result.data.record_locking_configurations[].restricted_actions` | `array` | Yes | — | List of actions that are restricted on the locked records. Maximum items: 5. |
| `result.data.record_locking_configurations[].created_time` | `string` | Yes | — | The timestamp when the record locking configuration was created. Format: `date-time`. |
| `result.data.record_locking_configurations[].excluded_fields` | `array` | Yes | — | List of fields that are excluded from the record locking configuration. Maximum items: 15. |
| `result.data.record_locking_configurations[].excluded_fields[].api_name` | `string` | Yes | — | The API name of the excluded field. Maximum length: 256. |
| `result.data.record_locking_configurations[].excluded_fields[].id` | `string` | Yes | — | The unique identifier of the excluded field. Maximum length: 32. |
| `result.data.record_locking_configurations[].feature_type` | `"record_locking"` | Yes | — | The type of feature for which the record locking configuration is applied. Allowed: `record_locking`. |
| `result.data.record_locking_configurations[].locking_rules` | `array` | Yes | — | List of locking rules defined in the record locking configuration. Maximum items: 5. |
| `result.data.record_locking_configurations[].locking_rules[].name` | `string` | Yes | — | The name of the locking rule. Maximum length: 256. |
| `result.data.record_locking_configurations[].locking_rules[].id` | `string` | Yes | — | The unique identifier of the locking rule. Maximum length: 32. |
| `result.data.record_locking_configurations[].locking_rules[].lock_existing_records` | `boolean` | Yes | — | Indicates whether existing records should be locked when the rule is applied. |
| `result.data.record_locking_configurations[].locking_rules[].criteria` | `object` | No | — | An object defining the criteria for the locking rule. |
| `result.data.record_locking_configurations[].locking_rules[].criteria.comparator` | `string` | Yes | — | The comparator used in the criteria. Maximum length: 256. |
| `result.data.record_locking_configurations[].locking_rules[].criteria.field` | `object` | Yes | — | An object containing minimal details of the field used in the criteria. |
| `result.data.record_locking_configurations[].locking_rules[].criteria.field.api_name` | `string` | Yes | — | The API name of the field used in the criteria. Maximum length: 256. |
| `result.data.record_locking_configurations[].locking_rules[].criteria.field.id` | `string` | Yes | — | The unique identifier of the field used in the criteria. Maximum length: 32. |
| `result.data.record_locking_configurations[].locking_rules[].criteria.type` | `string` | Yes | — | The type of criteria. Maximum length: 256. |
| `result.data.record_locking_configurations[].locking_rules[].criteria.value` | `unknown` | No | — | — |
| `result.data.record_locking_configurations[].modified_time` | `string` | Yes | — | The timestamp when the record locking configuration was last modified. Format: `date-time`. |
| `result.data.record_locking_configurations[].restricted_communications` | `array` | Yes | — | List of communication actions that are restricted on the locked records. Maximum items: 1. |
| `result.data.record_locking_configurations[].system_defined` | `boolean` | Yes | — | Indicates whether the record locking configuration is system-defined. |
| `result.data.record_locking_configurations[].created_by` | `object` | Yes | — | An object containing minimal details of the user who created the record locking configuration. |
| `result.data.record_locking_configurations[].created_by.name` | `string` | Yes | — | The name of the user who created the record locking configuration. Maximum length: 256. |
| `result.data.record_locking_configurations[].created_by.id` | `string` | Yes | — | The unique identifier of the user who created the record locking configuration. Maximum length: 32. |
| `result.data.record_locking_configurations[].modified_by` | `object` | Yes | — | An object containing minimal details of the user who last modified the record locking configuration. |
| `result.data.record_locking_configurations[].modified_by.name` | `string` | Yes | — | The name of the user who last modified the record locking configuration. Maximum length: 256. |
| `result.data.record_locking_configurations[].modified_by.id` | `string` | Yes | — | The unique identifier of the user who last modified the record locking configuration. Maximum length: 32. |
| `result.data.record_locking_configurations[].id` | `string` | Yes | — | The unique identifier of the record locking configuration. Maximum length: 32. |
| `result.data.record_locking_configurations[].restricted_custom_buttons` | `array \| null` | Yes | — | List of custom buttons that are restricted on the locked records (or null). |
| `result.data.record_locking_configurations[].restricted_custom_buttons[].name` | `string` | No | — | The name of the restricted custom button. Maximum length: 256. |
| `result.data.record_locking_configurations[].restricted_custom_buttons[].id` | `string` | Yes | — | The unique identifier of the restricted custom button. Maximum length: 32. |
| `result.data.record_locking_configurations[].lock_excluded_profiles` | `array` | Yes | — | List of profiles that are excluded from the record locking configuration. Maximum items: 15. |
| `result.data.record_locking_configurations[].lock_excluded_profiles[].name` | `string` | Yes | — | The name of the excluded profile. Maximum length: 256. |
| `result.data.record_locking_configurations[].lock_excluded_profiles[].id` | `string` | Yes | — | The unique identifier of the excluded profile. Maximum length: 32. |
| `result.data.record_locking_configurations[].lock_for_portal_users` | `boolean` | Yes | — | Indicates whether the records are locked for portal users. |
| `result.meta` | `object` | No | — | Additional response metadata (status, paging). |

> [!NOTE]
>
> This output schema is too large for an inline display. Read the complete live contract with `deepline describe zoho_crm_record_locking_configurations_get_record_locking_configuration --json`.

## Deepline cost

* Pricing model: `fixed` (per call).
* Estimated Deepline credits: `0` per pricing unit.
* Provider-native pricing may still exist outside Deepline credit billing.

## Related documentation

* [SDK V2 quickstart](https://deepline.com/docs/sdk-v2/quickstart.md)
* [SDK reference](https://deepline.com/docs/sdk-v2/sdk-reference.md)
* [Run tools across a CSV](https://deepline.com/docs/sdk-v2/batch-csv.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.