> ## 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: README
> To retrieve the locking information details of locked records. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.
To retrieve the locking information details of locked records.
Tool ID: `zoho_crm_locking_informations_get_record_locking_information_of_the_record`
## Run this action
Use the TypeScript SDK for a single call. Put `ctx.tools.execute(...)` inside a Play when the call should be durable, scheduled, or run across a CSV.
```ts theme={null}
import { Deepline } from 'deepline';
const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
'zoho_crm_locking_informations_get_record_locking_information_of_the_record',
{
"moduleName": "Example",
"recordId": "record_123"
},
);
console.log(result.toolResponse.raw);
```
### CLI
```bash theme={null}
deepline tools execute zoho_crm_locking_informations_get_record_locking_information_of_the_record --input '{
"moduleName": "Example",
"recordId": "record_123"
}' --json
```
## Example response
The SDK exposes this shape at `result.toolResponse.raw`. Values below are representative.
```json theme={null}
{
"data": {
"data": [
{
"id": "id_123"
}
],
"info": {
"per_page": 123,
"count": 123,
"page": 123,
"more_records": true
}
}
}
```
Use `deepline tools get zoho_crm_locking_informations_get_record_locking_information_of_the_record --json` for the latest machine-readable contract.
## Input reference
Use the Get Record Locking Information API to retrieve the locking information details of locked records in different modules.
| Name | Type | Required | Default | Details |
| -------------------- | -------- | -------- | ------- | ----------------------------------------------------------------------------------------------- |
| `payload.moduleName` | `string` | Yes | — | The API name of the module to which the locked record belongs. Maximum length: 256. |
| `payload.recordId` | `string` | Yes | — | The ID of the record from which the lock is to be removed. Maximum length: 32. |
| `payload.fields` | `string` | No | — | A comma-separated list of field API names to be included in the response. Maximum length: 2048. |
Show raw input schema
### Input JSON Schema
```json theme={null}
{
"type": "object",
"description": "Use the Get Record Locking Information API to retrieve the locking information details of locked records in different modules.",
"properties": {
"moduleName": {
"type": "string",
"description": "The API name of the module to which the locked record belongs.",
"maxLength": 256
},
"recordId": {
"type": "string",
"description": "The ID of the record from which the lock is to be removed.",
"maxLength": 32
},
"fields": {
"type": "string",
"description": "A comma-separated list of field API names to be included in the response.",
"maxLength": 2048
}
},
"required": [
"moduleName",
"recordId"
],
"additionalProperties": false
}
```
## Output reference
Standard tool result payload.
| Name | Type | Required | Default | Details |
| ------------------------------------------------------- | ----------------------------------- | -------- | ------- | ------------------------------------------------------------------------------------------------------- |
| `result.data` | `object` | Yes | — | A JSON object containing the locking information details of locked records. |
| `result.data.data` | `array` | Yes | — | An array of objects containing the locking information details of locked records. Maximum items: 1. |
| `result.data.data[].Locked_By__s` | `object` | No | — | An object containing the details of the user who locked the record. |
| `result.data.data[].Locked_By__s.name` | `string` | Yes | — | The name of the user who locked the record. Maximum length: 255. |
| `result.data.data[].Locked_By__s.id` | `string` | Yes | — | The ID of the user who locked the record. Maximum length: 255. |
| `result.data.data[].Locked_By__s.module` | `string` | Yes | — | The module of the user who locked the record. Maximum length: 255. |
| `result.data.data[].Locked_For__s` | `object` | No | — | An object containing the details of the record that is locked. |
| `result.data.data[].Locked_For__s.module` | `object` | Yes | — | An object containing the details of the module of the locked record. |
| `result.data.data[].Locked_For__s.module.api_name` | `string` | Yes | — | The API name of the module of the locked record. Maximum length: 255. |
| `result.data.data[].Locked_For__s.module.id` | `string` | Yes | — | The ID of the module of the locked record. Maximum length: 255. |
| `result.data.data[].Locked_For__s.name` | `string` | Yes | — | The name of the locked record. Maximum length: 255. |
| `result.data.data[].Locked_For__s.id` | `string` | Yes | — | The ID of the locked record. Maximum length: 255. |
| `result.data.data[].$field_states` | `string \| null` | No | — | The field states of the locked record. Can be null when no field state is present. Maximum length: 255. |
| `result.data.data[].Locked_Reason__s` | `string` | No | — | The reason for locking the record. Maximum length: 3000. |
| `result.data.data[].$editable` | `boolean` | No | — | Indicates whether the locked record is editable. |
| `result.data.data[].$sharing_permission` | `string` | No | — | The sharing permission of the locked record. Maximum length: 10000. |
| `result.data.data[].Lock_Source__s` | `"Manual" \| "Both" \| "Automatic"` | No | — | The source of the lock. Allowed: `Manual`, `Both`, `Automatic`. Maximum length: 255. |
| `result.data.data[].Locked_Time__s` | `string` | No | — | The time when the record was locked. Format: `date-time`. |
| `result.data.data[].Record_Locking_Configuration_Id__s` | `string` | No | — | The ID of the record locking configuration. Maximum length: 255. |
| `result.data.data[].Record_Locking_Rule_Id__s` | `string \| null` | No | — | The ID of the record locking rule. Maximum length: 255. |
| `result.data.data[].id` | `string` | Yes | — | The ID of the locking information record. Maximum length: 255. |
| `result.data.data[].Feature_Type__s` | `string` | No | — | The feature type of the locking information. Maximum length: 255. |
| `result.data.data[].$zia_visions` | `string \| null` | No | — | Zia Visions related information. Can be null when not present. Maximum length: 255. |
| `result.data.info` | `object` | Yes | — | An object containing the pagination details. |
| `result.data.info.per_page` | `integer` | Yes | — | The number of records per page. Format: `int32`. |
| `result.data.info.count` | `integer` | Yes | — | The total number of records. Format: `int32`. |
| `result.data.info.page` | `integer` | Yes | — | The current page number. Format: `int32`. |
| `result.data.info.more_records` | `boolean` | Yes | — | Indicates if there are more records available. |
| `result.meta` | `object` | No | — | Additional response metadata (status, paging). |
Show raw output schema
### Output JSON Schema
```json theme={null}
{
"type": "object",
"description": "Standard tool result payload.",
"properties": {
"data": {
"type": "object",
"description": "A JSON object containing the locking information details of locked records.",
"properties": {
"data": {
"type": "array",
"description": "An array of objects containing the locking information details of locked records.",
"maxItems": 1,
"items": {
"type": "object",
"description": "An object containing the locking information details of a locked record.",
"properties": {
"Locked_By__s": {
"type": "object",
"description": "An object containing the details of the user who locked the record.",
"properties": {
"name": {
"type": "string",
"description": "The name of the user who locked the record.",
"maxLength": 255
},
"id": {
"type": "string",
"description": "The ID of the user who locked the record.",
"maxLength": 255
},
"module": {
"type": "string",
"description": "The module of the user who locked the record.",
"maxLength": 255
}
},
"required": [
"name",
"id",
"module"
],
"additionalProperties": false
},
"Locked_For__s": {
"type": "object",
"description": "An object containing the details of the record that is locked.",
"properties": {
"module": {
"type": "object",
"description": "An object containing the details of the module of the locked record.",
"properties": {
"api_name": {
"type": "string",
"description": "The API name of the module of the locked record.",
"maxLength": 255
},
"id": {
"type": "string",
"description": "The ID of the module of the locked record.",
"maxLength": 255
}
},
"required": [
"api_name",
"id"
],
"additionalProperties": false
},
"name": {
"type": "string",
"description": "The name of the locked record.",
"maxLength": 255
},
"id": {
"type": "string",
"description": "The ID of the locked record.",
"maxLength": 255
}
},
"required": [
"module",
"name",
"id"
],
"additionalProperties": false
},
"$field_states": {
"type": [
"string",
"null"
],
"description": "The field states of the locked record. Can be null when no field state is present.",
"maxLength": 255
},
"Locked_Reason__s": {
"type": "string",
"description": "The reason for locking the record.",
"maxLength": 3000
},
"$editable": {
"type": "boolean",
"description": "Indicates whether the locked record is editable."
},
"$sharing_permission": {
"type": "string",
"description": "The sharing permission of the locked record.",
"maxLength": 10000
},
"Lock_Source__s": {
"type": "string",
"description": "The source of the lock.",
"maxLength": 255,
"enum": [
"Manual",
"Both",
"Automatic"
]
},
"Locked_Time__s": {
"type": "string",
"description": "The time when the record was locked.",
"format": "date-time"
},
"Record_Locking_Configuration_Id__s": {
"type": "string",
"description": "The ID of the record locking configuration.",
"maxLength": 255
},
"Record_Locking_Rule_Id__s": {
"type": [
"string",
"null"
],
"description": "The ID of the record locking rule.",
"maxLength": 255
},
"id": {
"type": "string",
"description": "The ID of the locking information record.",
"maxLength": 255
},
"Feature_Type__s": {
"type": "string",
"description": "The feature type of the locking information.",
"maxLength": 255
},
"$zia_visions": {
"type": [
"string",
"null"
],
"description": "Zia Visions related information. Can be null when not present.",
"maxLength": 255
}
},
"required": [
"id"
],
"additionalProperties": false
}
},
"info": {
"type": "object",
"description": "An object containing the pagination details.",
"properties": {
"per_page": {
"type": "integer",
"description": "The number of records per page.",
"format": "int32"
},
"count": {
"type": "integer",
"description": "The total number of records.",
"format": "int32"
},
"page": {
"type": "integer",
"description": "The current page number.",
"format": "int32"
},
"more_records": {
"type": "boolean",
"description": "Indicates if there are more records available."
}
},
"required": [
"per_page",
"count",
"page",
"more_records"
],
"additionalProperties": false
}
},
"required": [
"data",
"info"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"description": "Additional response metadata (status, paging).",
"additionalProperties": true
}
},
"required": [
"data"
],
"additionalProperties": false
}
```
## 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](/docs/sdk-v2/quickstart)
* [SDK reference](/docs/sdk-v2/sdk-reference)
* [Run tools across a CSV](/docs/sdk-v2/batch-csv)