objects_get_object_schema_by_key
Retrieve the schema for any custom or standard object by key, optionally fetching all field definitions to understand its structure.
Instructions
Get Object Schema by key / id
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"key": "<key>"
},
"name": "objects_get_object_schema_by_key"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| key | Yes | key of the custom or standard object. For custom objects, the key must include the prefix “custom_objects.”. This key can be found on the Object Details page under Settings in the UI. | |
| locationId | No | location id of the sub account Defaults to GHL_LOCATION_ID when omitted. | |
| fetchProperties | No | Fetch Properties , Fetches all the standard / custom fields of the object when set to true |