REST API

Get Bridge

Fetch the summary 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 what the Bridge is configured to look for — the buyer scope it watches, the search filters/queries it runs, and the match/scoring criteria — call getBridgeConfiguration. 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))

}

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>",
  "filterType": "RFP",
  "status": "Initializing",
  "updatedAt": "2023-11-07T05:31:56Z",
  "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 — also what each of its rows represents, surfaced per row as entity. RFP bridges match RFPs.

Available options:

RFP,

Meeting,

Purchase,

Buyer,

TopBuyer,

Contact,

Signal,

Conference,

JobChange,

SequenceBuyer,

SequenceContact,

SequenceJobChange,

VendorPresence,

ProductCompetitorPresence,

CompanionPresence,

ContractExpiration

status

enum<string>

required

Current status of the bridge

Available options:

Initializing,

Matching,

Draft,

Open,

Failed,

Deleting

updatedAt

string<date-time>

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

⌘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))

}

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>",
  "filterType": "RFP",
  "status": "Initializing",
  "updatedAt": "2023-11-07T05:31:56Z",
  "rowCount": 123
}