Skip to main content
GET
/
api
/
external
/
bridge
/
{bridgeId}
/
column
/
metadata
List existing columns with their per-type settings
curl --request GET \
  --url https://dashboard.starbridge.ai/api/external/bridge/{bridgeId}/column/metadata \
  --header 'Authorization: Bearer <token>'
[
  {
    "columnId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "bridgeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "additionalFields": [
      {
        "key": "<string>",
        "name": "<string>",
        "fieldFormat": {
          "baseFormat": "text",
          "description": "<string>",
          "enumerationValues": [
            {
              "value": "<string>",
              "label": "<string>"
            }
          ],
          "currency": "USD",
          "listElementBaseFormat": "text",
          "outputFields": [
            {
              "name": "<string>",
              "type": "text",
              "description": "<string>"
            }
          ]
        }
      }
    ],
    "webAgentModel": "Lite",
    "linkSettings": {
      "sourceBridgeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "includedStatuses": [
        "<string>"
      ],
      "maxAgeRelativePeriod": "Future"
    },
    "vendorPresenceSettings": {
      "serviceProviders": [
        {
          "name": "<string>",
          "serviceProviderAliases": [
            "<string>"
          ],
          "productNamesOrAliases": [
            "<string>"
          ]
        }
      ],
      "runWebPresence": true,
      "contextPrompt": "<string>",
      "runContractEstimation": true
    },
    "emailGenerationSettings": {
      "emailSubjectTemplate": "<string>",
      "emailBodyTemplate": "<string>",
      "showParentColumn": true,
      "snippetDefinitions": {}
    },
    "webhookUrl": "<string>"
  }
]

Documentation Index

Fetch the complete documentation index at: https://hc.starbridge.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

HTTP Bearer Authentication

Path Parameters

​
bridgeId
string
required

Response

Per-column metadata for existing columns

​
columnId
string<uuid>
required

UUID of the existing column. Cross-reference to bridge columns from getBridge.

​
bridgeId
string<uuid>
required

UUID of the bridge this column belongs to

​
additionalFields
BridgeRowAttributeOption · object[]
required

Extra reference paths exposed by this column. For basis columns (e.g. a Get Contact column that attaches contact records), these surface synthetic refs like {columnId$basis:firstName} you can plug into prompts or referenceFieldPath on createReferenceColumn.

​
webAgentModel
enum<string> | null

Web agent model — set on web-agent columns.

Available options:
Lite,
Base,
Core,
Core2X,
Pro,
Ultra,
UltraTwoX,
UltraFourX,
UltraEightX
​
linkSettings
BridgeLinkSettings · object

Cross-bridge link settings — set on cross-bridge reference columns.

​
vendorPresenceSettings
BridgeCompetitorPresenceSettings · object

Vendor presence settings — set on vendor presence columns.

​
emailGenerationSettings
BridgeEmailGenerationSettings · object

Email generation settings — set on email template columns.

​
webhookUrl
string | null

Webhook URL — set on webhook columns.