objects_get_object_schema_by_key
Get Object Schema by key / id
This record as markdown: /tools/aiwerk-mcp-server-ghl/objects-get-object-schema-by-key.md
What objects_get_object_schema_by_key does on Ghl
AI agents call objects_get_object_schema_by_key to retrieve information from Ghl without modifying anything. It is typically the context-gathering step in research, monitoring, and reporting workflows, before the agent takes action elsewhere.
| Parameter | Type | Required | Description |
|---|---|---|---|
key | string | 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 un |
locationId | string | — | location id of the sub account Defaults to GHL_LOCATION_ID when omitted. |
fetchProperties | string | — | Fetch Properties , Fetches all the standard / custom fields of the object when set to true |
Parameters from the server's own tool schema.
Why objects_get_object_schema_by_key is rated Low
Even though objects_get_object_schema_by_key only reads data, uncontrolled read access leaks sensitive information and racks up API costs: an agent caught in a retry loop can make thousands of calls a minute without anyone noticing.
Attacks that exploit this kind of access
The rule that runs objects_get_object_schema_by_key safely
PolicyLayer is an MCP gateway: it sits between your AI agents and Ghl, and checks every tool call against a rule you set before the call runs. Nothing changes on the server itself. For objects_get_object_schema_by_key, this is the rule to start with:
objects_get_object_schema_by_key is read-only, so it stays allowed. Everything else on the server is denied unless you say otherwise.
The button opens the PolicyLayer dashboard: create your workspace, connect Ghl, apply this rule, and every objects_get_object_schema_by_key call is checked against it from then on.
Questions about objects_get_object_schema_by_key
Get Object Schema by key / id. It is categorised as a Read tool in the Ghl MCP Server, which means it retrieves data without modifying state.
objects_get_object_schema_by_key accepts 3 parameters: key, locationId, fetchProperties. Required: key. The full parameter table on this page comes from the server's own tool schema.
Register the Ghl MCP server in PolicyLayer and add a rule for objects_get_object_schema_by_key: allow, deny, rate-limit, or require approval. Point your MCP client at the PolicyLayer proxy URL and the rule is enforced on every call, before it reaches Ghl. Nothing to install.
objects_get_object_schema_by_key is a Read tool with low risk. Read-only tools are generally safe to allow by default.
Yes. Add a rate_limit block to the objects_get_object_schema_by_key rule in your PolicyLayer policy. For example, setting max: 10 and window: 60 limits the tool to 10 calls per minute. Rate limits are tracked per agent session and reset automatically.
Set action: deny in the PolicyLayer policy for objects_get_object_schema_by_key. The AI agent will receive a policy violation error and cannot call the tool. You can also include a reason field to explain why the tool is blocked.
objects_get_object_schema_by_key is provided by the Ghl MCP server (@aiwerk/mcp-server-ghl). PolicyLayer sits as a proxy in front of this server to enforce policies before tool calls reach the server.
More on Ghl, and thousands of servers like it.
This server
Across the catalogue