Ghl Get Custom Fields By Object Key

Immutable Catalog Entry

This descriptor comes from the active versioned Portal catalog.

READghl.ghl_get_custom_fields_by_object_key

• Contract tier: agent_ready
• Risk: read
• Catalog version: 2026-07-12.2
• Descriptor hash: 0eaa01db8b95fef5092d243ccad334de5201004729b497f2f6ea69f1f38fa7d5

Get all custom fields and folders for a specific object key (e.g., custom object or company). GHL category: App Marketplace. This is a read-only GHL API operation.

Request Body

{
  "jsonrpc": "2.0",
  "id": "ghl-ghl-get-custom-fields-by-object-key-example",
  "method": "tools/call",
  "params": {
    "name": "ghl.ghl_get_custom_fields_by_object_key",
    "arguments": {
      "objectKey": "objectKey_example",
      "tenantId": "tenantId_123",
      "locationId": "locationId_123",
      "strictTenant": false,
      "includeFieldDetails": false
    }
  }
}

Arguments Schema

{
  "type": "object",
  "required": [
    "objectKey"
  ],
  "properties": {
    "tenantId": {
      "type": "string",
      "description": "Tenant ID from list_tenants."
    },
    "objectKey": {
      "type": "string",
      "description": "Object key to get fields for. Format: \"custom_object.{objectKey}\" for custom objects. Example: \"custom_object.pet\""
    },
    "locationId": {
      "type": "string",
      "description": "GoHighLevel location ID (will use default if not provided)"
    },
    "strictTenant": {
      "type": "boolean",
      "default": true,
      "description": "Require tenantId to match locationId routing (default: true)."
    },
    "includeFieldDetails": {
      "type": "boolean",
      "description": "Defaults to false. When false, returns compact field/folder summaries and omits large option lists such as country dropdown values."
    }
  }
}

Output Schema

{
  "type": "object",
  "required": [
    "ok",
    "data",
    "error",
    "meta"
  ],
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Whether the GHL MCP operation completed successfully."
    },
    "data": {
      "anyOf": [
        {
          "type": "object",
          "additionalProperties": true
        },
        {
          "type": "array",
          "items": {}
        },
        {
          "type": "string"
        },
        {
          "type": "number"
        },
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "description": "Tool-specific GHL or local navigation result when ok is true."
    },
    "meta": {
      "type": "object",
      "description": "Safe execution, routing, and timing metadata.",
      "additionalProperties": true
    },
    "error": {
      "anyOf": [
        {
          "type": "object",
          "additionalProperties": true
        },
        {
          "type": "null"
        }
      ],
      "description": "Safe error details when ok is false; credential values are never returned."
    }
  },
  "description": "Normalized GHL MCP response envelope.",
  "additionalProperties": false
}

Code Examples

cURL

curl -X POST 'https://portal.madpanda3d.com/api/mcp' \
  -H 'Authorization: Bearer mad_live_***' \
  -H 'Content-Type: application/json' \
  -d '{
  "jsonrpc": "2.0",
  "id": "ghl-ghl-get-custom-fields-by-object-key-example",
  "method": "tools/call",
  "params": {
    "name": "ghl.ghl_get_custom_fields_by_object_key",
    "arguments": {
      "objectKey": "objectKey_example",
      "tenantId": "tenantId_123",
      "locationId": "locationId_123",
      "strictTenant": false,
      "includeFieldDetails": false
    }
  }
}'

Node.js

const response = await fetch('https://portal.madpanda3d.com/api/mcp', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer mad_live_***',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "jsonrpc": "2.0",
  "id": "ghl-ghl-get-custom-fields-by-object-key-example",
  "method": "tools/call",
  "params": {
    "name": "ghl.ghl_get_custom_fields_by_object_key",
    "arguments": {
      "objectKey": "objectKey_example",
      "tenantId": "tenantId_123",
      "locationId": "locationId_123",
      "strictTenant": false,
      "includeFieldDetails": false
    }
  }
}),
});
const data = await response.json();
console.log(data);

Python

import requests

url = 'https://portal.madpanda3d.com/api/mcp'
headers = {
    'Authorization': 'Bearer mad_live_***',
    'Content-Type': 'application/json',
}
payload = {
  "jsonrpc": "2.0",
  "id": "ghl-ghl-get-custom-fields-by-object-key-example",
  "method": "tools/call",
  "params": {
    "name": "ghl.ghl_get_custom_fields_by_object_key",
    "arguments": {
      "objectKey": "objectKey_example",
      "tenantId": "tenantId_123",
      "locationId": "locationId_123",
      "strictTenant": false,
      "includeFieldDetails": false
    }
  }
}
response = requests.post(url, headers=headers, json=payload, timeout=60)
print(response.json())

Example Responses

200 Success

{
  "ok": true,
  "message": "Tool ghl.ghl_get_custom_fields_by_object_key executed successfully.",
  "note": "Response shape varies by MCP tool. Inspect live responses for exact fields."
}

502 Upstream Error

{
  "ok": false,
  "classification": "upstream_http_error",
  "message": "Upstream MCP returned a non-success status."
}