REST API

Search Buyers

Search for buyer institutions — cities, counties, school districts, higher-education institutions, police and fire departments, federal agencies, and other public-sector entities — by name. Returns a list of candidates; pick the single buyer that best fits the user’s intent based on name, type, and location, then use its id (the buyer ID) for downstream tools. If the user mentions a state or province, pass buyerStateCode as the matching StateMapping enum name (the server resolves it to the corresponding ISO 3166-2 code).

GET

api

external

buyer

quick

Search Buyers

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

{
  "buyers": [
    {
      "id": "<string>",
      "name": "<string>",
      "countryCode": "<string>",
      "fromSourceFile": true,
      "type": "AdministrativeAgency",
      "stateCode": "<string>",
      "url": "<string>",
      "tags": [
        "<string>"
      ],
      "linkedinSlug": "<string>",
      "logoPath": "<string>"
    }
  ]
}

Authorizations

Authorization

string

header

required

HTTP Bearer Authentication

Query Parameters

buyerName

string

required

Buyer name to search Buyer entity by.

buyerStateCode

string

StateMapping enum value for the buyer's ISO 3166-2 state code. Optional.

limit

string

Maximum number of buyers to return. Defaults to 10.

Response

Matching buyers ordered by relevance.

buyers

BuyerBrief · object[]

required

Matching buyers (institutions) ordered by search relevance. Pick the single buyer that best fits the user's intent.

Show child attributes

Get Buyer AttributeRetrieve a single structured attribute about a buyer (institution) by its key, as defined in the BuyerField enum. Buyers include cities, counties, higher-education institutions, school districts, police and fire departments, federal agencies, and other public-sector entities. See the `buyerAttribute` parameter for the full list of available keys and what each one returns.

⌘I

Search Buyers

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

{
  "buyers": [
    {
      "id": "<string>",
      "name": "<string>",
      "countryCode": "<string>",
      "fromSourceFile": true,
      "type": "AdministrativeAgency",
      "stateCode": "<string>",
      "url": "<string>",
      "tags": [
        "<string>"
      ],
      "linkedinSlug": "<string>",
      "logoPath": "<string>"
    }
  ]
}

REST API

Webhooks

Documentation Index

Authorizations

Query Parameters

Response