Skip to main content
GET
Get Bridge

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,
VendorPresence,
ProductCompetitorPresence,
CompanionPresence
status
enum<string>
required

Lifecycle status. Initializing and Matching mean the bridge is still building its rows, Open means it is live, Failed means the build failed, Draft means it was never started. An imported bridge (isImported) waits in Draft, with no rows, until its contacts' buyer matches are reviewed and completed.

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

url
string
required

Starbridge dashboard link that opens this bridge. Give it to the user when they ask for a link to the bridge.

rowCount
integer

Number of rows in the bridge. While the bridge is re-running (status is Initializing or Matching) this can still include rows from before the re-run; it is final once the status changes.

isManual
boolean

True when the bridge is Manual: it has no source filter and never picks up rows on its own; its rows are added and removed by hand. Never call it static to the user.

isStatic
boolean

Deprecated: read isManual, which holds the same value.

isImported
boolean

True when the bridge was built from a list of contacts the user imported rather than from a search: it holds only those contacts and never picks up rows on its own, though its rows follow later updates to the matched contacts. It cannot be rebuilt or duplicated, and of its configuration only the name and description can change.

private
boolean

Visible only to its creator

live
boolean | null

Live updates: true while the bridge keeps getting new rows, false for a snapshot. Null on a bridge type without the setting (Buyer, Top Buyers, CRM, vendor presence), which keeps updating

archivedRowCount
integer | null

Number of archived rows, which rowCount leaves out and listBridgeRows lists with archived: true; null when this read did not count them