REST API

Get Bridge

Fetch the configuration of a single Bridge by ID — name, owner, filter type, current status, last-updated timestamp, and total row count. A Bridge watches for one type of buyer activity — RFPs, meetings, purchases, conferences, contact or job changes, or other signals — within a buyer-list scope, extracts a configurable set of column values when something matches, and stores each match as a row.

For the per-column schema (columnId, name, prompt, type, fieldFormat, etc.) needed to construct column-targeted filters in listBridgeRows, call getBridgeColumnMetadata.

GET

api

external

bridge

{bridgeId}

Get Bridge

curl --request GET \
  --url https://dashboard.starbridge.ai/api/external/bridge/{bridgeId} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://dashboard.starbridge.ai/api/external/bridge/{bridgeId}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://dashboard.starbridge.ai/api/external/bridge/{bridgeId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://dashboard.starbridge.ai/api/external/bridge/{bridgeId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://dashboard.starbridge.ai/api/external/bridge/{bridgeId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://dashboard.starbridge.ai/api/external/bridge/{bridgeId}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://dashboard.starbridge.ai/api/external/bridge/{bridgeId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "bridgeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "userId": "<string>",
  "updatedAt": "<string>",
  "rowCount": 123
}

Authorizations

Authorization

string

header

required

HTTP Bearer Authentication

Path Parameters

bridgeId

string

required

Response

Bridge details

bridgeId

string<uuid>

required

Unique identifier for the bridge

name

string

required

Name of the bridge

userId

string

required

User ID who created and owns the bridge

filterType

enum<string>

required

Type of filter applied to the bridge

Available options:

RFP,

Meeting,

Purchase,

Buyer,

Contact,

Signal,

Conference,

JobChange,

SequenceBuyer,

SequenceContact,

SequenceJobChange

status

enum<string>

required

Current status of the bridge

Available options:

Initializing,

Matching,

Draft,

Open,

Failed,

Deleting

updatedAt

string

required

Timestamp when a user last edited this bridge's configuration (name, columns, sharing). Does NOT indicate when new rows were added

rowCount

integer

Total number of rows in the bridge

List Bridge RowsList the rows of a single Bridge — the concrete matches the Bridge has produced — with optional filtering, sorting, and full-text search. Each row carries a processing status, optional buyer/organizer association, an `updatedAt` timestamp, and the per-column values populated for that match. The per-row `columns` map is keyed by the human-readable column name (not by columnId), and values are polymorphic per the column's `fieldFormat` (string / number / boolean / object / null). Prefer narrowing server-side with `filters`, `sorts`, and `query` in the request body over scanning every page. For any column-targeted filter or sort — including Match Score, Match reasoning, and any user-defined column — first call `getBridgeColumnMetadata` to obtain that column's `columnId` UUID and pass it as `BridgeFilters.terms[].field` or `RowSort.column`. The column's display name, `key`, or any prefixed reference is NOT a valid value. A small set of common entry-level fields (`status`, `buyerId`, `opportunityId`, `entryName`, `triggeredAt`) is also accepted for filtering. Sort or filter columns that are not mapped on the server return 400. See `ListBridgeRowsRequest` for the full schema of supported filter terms, operations, and sort columns. To paginate, start at `pageNumber=1` and increment until `pageNumber == totalPages`. Note on consistency: the data backing search/sort/filter is maintained separately from the row values returned here, and the two can briefly drift apart — especially while the service is under heavy load. As a result, recent changes (new rows, status changes, updated column values, `updatedAt`, etc.) may not be reflected in listing, sorting, or filtering immediately; they usually become consistent within a short time. If a just-changed row does not appear where you expect, retry shortly.

⌘I

Get Bridge

curl --request GET \
  --url https://dashboard.starbridge.ai/api/external/bridge/{bridgeId} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://dashboard.starbridge.ai/api/external/bridge/{bridgeId}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://dashboard.starbridge.ai/api/external/bridge/{bridgeId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://dashboard.starbridge.ai/api/external/bridge/{bridgeId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://dashboard.starbridge.ai/api/external/bridge/{bridgeId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://dashboard.starbridge.ai/api/external/bridge/{bridgeId}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://dashboard.starbridge.ai/api/external/bridge/{bridgeId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "bridgeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "userId": "<string>",
  "updatedAt": "<string>",
  "rowCount": 123
}