List Bridges

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

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

fetch('https://dashboard.starbridge.ai/api/external/bridge', 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",
  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"

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

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

{
  "pageNumber": 123,
  "pageSize": 123,
  "totalItems": 123,
  "totalPages": 123,
  "result": [
    {
      "bridgeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "userId": "<string>",
      "filterType": "RFP",
      "status": "Initializing",
      "updatedAt": "2023-11-07T05:31:56Z",
      "url": "<string>",
      "rowCount": 123,
      "folderId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "folderPath": "<string>",
      "isManual": true,
      "isStatic": true,
      "isImported": true,
      "live": true,
      "private": true
    }
  ]
}

REST API

List Bridges

List the bridges in the organization. A bridge watches for one kind of buyer activity — RFPs, meetings, purchases, conferences, contact or job changes, vendor presence, or other signals — inside a buyer scope, extracts a configurable set of column values whenever something matches, and keeps each match as a row. This is the entry point to everything else: a bridge’s bridgeId is what getBridgeFull, listBridgeRows, processBridgeRows and exportBridge take.

Narrow the list rather than paging through it; each parameter documents its own values. query matches the bridge name, filterType the bridge type — which is also what its rows represent, so filterType=RFP finds the bridges whose rows are RFPs — and statuses the lifecycle. folderId limits the list to the bridges directly inside one folder (call listBridgeFolders for the tree), subscribedOnly=true to the ones you are subscribed to, createdByUserId to a named user’s, userIdsHaveAccessTo to what a named user can see, and buyerListId to the ones built on a saved buyer list.

Paging: start at pageNumber=1 and increment while pageNumber < totalPages; a page with no items is the end. pageSize defaults to 10 and may not exceed 100; prefer 20 or fewer, since each item carries the bridge’s row count and folder path. Order with sortField and sortDirection.

Admins and Builders see every shared bridge in the organization, and a Consumer only the bridges shared with them or that they created. Admins don’t see other users’ private bridges either, so the list may not show everything in the organization. Once you have a bridgeId, call getBridgeFull for its columns and configuration before filtering its rows — filters and sorts address columns by columnId, never by name.

GET

api

external

bridge

List Bridges

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

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

fetch('https://dashboard.starbridge.ai/api/external/bridge', 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",
  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"

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

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

{
  "pageNumber": 123,
  "pageSize": 123,
  "totalItems": 123,
  "totalPages": 123,
  "result": [
    {
      "bridgeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "userId": "<string>",
      "filterType": "RFP",
      "status": "Initializing",
      "updatedAt": "2023-11-07T05:31:56Z",
      "url": "<string>",
      "rowCount": 123,
      "folderId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "folderPath": "<string>",
      "isManual": true,
      "isStatic": true,
      "isImported": true,
      "live": true,
      "private": true
    }
  ]
}

Authorizations

Authorization

string

header

required

HTTP Bearer Authentication

Query Parameters

sortField

enum<string>

default:Name

Name, EntriesCount, Type, CreatedBy, CreditUsage, SharedWith, LastUpdatedByUser or CreatedAt

Available options:

Name,

RowsCount,

Type,

CreatedBy,

CreditUsage,

SharedWith,

LastUpdatedByUser,

CreatedAt

sortDirection

enum<string>

default:ASC

ASC or DESC

Available options:

ASC,

DESC

query

string

Filter by bridge name (substring match)

viewMode

string

folderId

string

Only bridges inside this folder (UUID)

subscribedOnly

string

true to return only bridges you are subscribed to

live

string

true for only bridges with live updates on, false for only those with them off; a bridge type without the setting counts as on

pageNumber

integer

default:1

Page number, 1-based. Minimum 1.

pageSize

integer

default:10

Page size. Must be > 0 and <= 100. Prefer <= 20.

filterType

enum<string>[]

Bridge type(s) to include. Without it the list holds RFP, Meeting, Purchase, Buyer, Contact, Signal, Conference, JobChange, VendorPresence bridges; name TopBuyer, ProductCompetitorPresence or CompanionPresence to list those

Available options:

RFP,

Meeting,

Purchase,

Buyer,

TopBuyer,

Contact,

Signal,

Conference,

JobChange,

VendorPresence,

ProductCompetitorPresence,

CompanionPresence

statuses

enum<string>[]

Bridge lifecycle status(es) to include: Open (live), Initializing and Matching (still building), Draft, Failed, Deleting

Available options:

Initializing,

Matching,

Draft,

Open,

Failed,

Deleting

createdByUserId

string[]

Only bridges owned by these user id(s)

userIdsHaveAccessTo

string[]

Only bridges these user id(s) can see — how you find what a teammate has access to

buyerListId

string<uuid>[]

Only bridges whose buyer scope is one of these saved buyer lists

Response

Paginated list of bridges

pageNumber

integer

required

pageSize

integer

required

totalItems

integer

required

totalPages

integer

required

result

BridgeListItem · object[]

required

Show child attributes

⌘I