Get custom connector

Fetch a custom connector by id. Requires the admin scope.

GET

/api/v2/settings/custom-connectors/{id}

GET

/settings/custom-connectors/{id}

curl -X GET "https://productlane.com/api/v2/settings/custom-connectors/{id}" \
  -H "Authorization: Bearer $PRODUCTLANE_API_KEY"

Authorization

Authorization
string
header
required
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Parameters

id
string
path
required

Response

application/json

Successful response

id
string
required
title
string
required
description
string | null
required
url
string
required
logo_url
string | null
required
Logo shown in the sidebar. null shows the favicon of url.
type
enum<string>
required
One of:
http
mcp
order
integer
required
headers
object[]
required
Header names only. Stored values are encrypted and never returned.
available_to_agent
boolean
required
Whether the customer-facing agent (widget, email, Slack replies) may read this connector. For mcp connectors it is true when agent_tools is not empty.
agent_tools
string[]
required
mcp only: tools the customer-facing agent may call. Every other tool stays internal (copilot, AI drafts).
internal_blocked_tools
string[]
required
mcp only: tools hidden from internal callers as well.
reachable_without_identity
boolean
required
mcp only: the widget agent may call it before the visitor verifies their email. For public knowledge like docs or status.
tool_policies
any
Field rules per tool name, in the dashboard's policy format. Set with PUT /settings/custom-connectors/{id}/tool-policy.
created_at
string
required
updated_at
string
required

{
  "id": "string",
  "title": "string",
  "description": "string",
  "url": "string",
  "logo_url": "string",
  "type": "http",
  "order": 0,
  "headers": [
    {
      "id": "string",
      "key": "string"
    }
  ],
  "available_to_agent": true,
  "agent_tools": [
    "string"
  ],
  "internal_blocked_tools": [
    "string"
  ],
  "reachable_without_identity": true,
  "tool_policies": null,
  "created_at": "string",
  "updated_at": "string"
}

{ "id": "string", "title": "string", "description": "string", "url": "string", "logo_url": "string", "type": "http", "order": 0, "headers": [ { "id": "string", "key": "string" } ], "available_to_agent": true, "agent_tools": [ "string" ], "internal_blocked_tools": [ "string" ], "reachable_without_identity": true, "tool_policies": null, "created_at": "string", "updated_at": "string" }