Skip to main content

Oauth Get Access Token

Immutable Catalog Entry

This descriptor comes from the active versioned Portal catalog.

WRITEghl.oauth_get_access_token
  • Contract tier: agent_ready
  • Risk: write
  • Catalog version: 2026-07-12.2
  • Descriptor hash: 9fe04101f01f4072b5603df017cd7e2e0d21030277f47c8898870f32128511d4

Exchange OAuth credentials for a GHL access token. GHL category: App Marketplace. This writes to GHL Marketplace/OAuth state. This write has billing or auth side effects and requires confirmApply = "CONFIRM APPLY". OAuth/token-like provider fields are redacted from output by default and should never be copied into chat unless the user explicitly handles credentials outside this MCP.

Request Body

{
"jsonrpc": "2.0",
"id": "ghl-oauth-get-access-token-example",
"method": "tools/call",
"params": {
"name": "ghl.oauth_get_access_token",
"arguments": {
"body": {},
"query": {},
"tenantId": "tenantId_123",
"locationId": "locationId_123",
"confirmApply": "confirmApply_example",
"strictTenant": false
}
}
}

Arguments Schema

{
"type": "object",
"required": [
"body"
],
"properties": {
"body": {
"type": "object",
"description": "Request body for this official GHL Marketplace/OAuth endpoint, using only fields documented by GHL. Do not include secrets unless the user explicitly provides them for this exchange.",
"additionalProperties": true
},
"query": {
"type": "object",
"description": "Optional GHL-supported query parameters for this official Marketplace/OAuth endpoint, such as app, company, pagination, charge, or installed-location filters where documented.",
"additionalProperties": true
},
"tenantId": {
"type": "string",
"description": "Tenant ID from list_tenants."
},
"locationId": {
"type": "string",
"description": "Optional GHL location ID. If provided, it must match the authenticated runtime location; otherwise the runtime location is injected only where the official Marketplace/OAuth endpoint requires it."
},
"confirmApply": {
"type": "string",
"description": "Required for destructive, billing, or token-generating Marketplace/OAuth operations. Set exactly to \"CONFIRM APPLY\" only after the user explicitly confirms the side effect."
},
"strictTenant": {
"type": "boolean",
"default": true,
"description": "Require tenantId to match locationId routing (default: true)."
}
},
"additionalProperties": false
}

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 -X POST 'https://portal.madpanda3d.com/api/mcp' \
-H 'Authorization: Bearer mad_live_***' \
-H 'Content-Type: application/json' \
-d '{
"jsonrpc": "2.0",
"id": "ghl-oauth-get-access-token-example",
"method": "tools/call",
"params": {
"name": "ghl.oauth_get_access_token",
"arguments": {
"body": {},
"query": {},
"tenantId": "tenantId_123",
"locationId": "locationId_123",
"confirmApply": "confirmApply_example",
"strictTenant": false
}
}
}'

Example Responses

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