REST API

List Bridges

List the saved Bridges (monitoring definitions) in the organization. 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. Use this to discover available Bridges and their identifiers.

Filter by query (name substring), filterType, createdByUserId, userIdsHaveAccessTo, or buyerListId. To paginate, start at pageNumber=1 and increment until pageNumber == totalPages. For the columns defined on a specific Bridge, call getBridgeColumnMetadata; this endpoint does not return column metadata inline.

A Bridge’s filterType says what its rows represent, so it is also how you reach the underlying entities: filterType=RFP finds the Bridges whose rows are RFPs.

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",
      "rowCount": 123
    }
  ]
}

Authorizations

Authorization

string

header

required

HTTP Bearer Authentication

Query Parameters

sortField

enum<string>

default:Name

Available options:

Name,

RowsCount,

Type,

CreatedBy,

CreditUsage,

SharedWith,

LastUpdatedByUser,

CreatedAt

sortDirection

enum<string>

default:ASC

Available options:

ASC,

DESC

query

string

Filter by bridge name (substring match)

viewMode

string

folderId

string

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 filter type(s)

Available options:

RFP,

Meeting,

Purchase,

Buyer,

TopBuyer,

Contact,

Signal,

Conference,

JobChange,

SequenceBuyer,

SequenceContact,

SequenceJobChange,

VendorPresence,

ProductCompetitorPresence,

CompanionPresence,

ContractExpiration

createdByUserId

string[]

User ID(s) of the creator(s)

userIdsHaveAccessTo

string[]

buyerListId

string<uuid>[]

Buyer list ID(s) set up for the bridges

Response

Paginated list of bridges

pageNumber

integer

required

pageSize

integer

required

totalItems

integer

required

totalPages

integer

required

result

BridgeResponse · object[]

required

Show child attributes

⌘I

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",
      "rowCount": 123
    }
  ]
}