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 — column metadata is no longer returned inline by this endpoint.

GET

/

api

/

external

/

bridge

List Bridges

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

{
  "pageNumber": 123,
  "pageSize": 123,
  "totalItems": 123,
  "totalPages": 123,
  "result": [
    {
      "bridgeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "userId": "<string>",
      "filterType": "RFP",
      "status": "Initializing",
      "updatedAt": "<string>",
      "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)

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,

Contact,

Signal,

Conference,

JobChange

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

Get BridgeFetch 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`.

⌘I

List Bridges

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

{
  "pageNumber": 123,
  "pageSize": 123,
  "totalItems": 123,
  "totalPages": 123,
  "result": [
    {
      "bridgeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "userId": "<string>",
      "filterType": "RFP",
      "status": "Initializing",
      "updatedAt": "<string>",
      "rowCount": 123
    }
  ]
}