REST API

Get Buyer Attributes in bulk

Retrieve multiple structured attributes about a buyer (institution) in a single call, so you don’t have to make one request per attribute (which clutters MCP / Ask Starbridge sessions). Buyers include cities, counties, higher-education institutions, school districts, police and fire departments, federal agencies, and other public-sector entities. Pass one or more attribute query parameters (each a BuyerField key, the same keys getBuyerSchema documents) to select what to return, or omit attribute entirely to get every available attribute. The response buyerData maps each requested key to its value (JsonNull when the attribute is unset). Find a buyer’s id first with searchBuyersByCriteria, and call getBuyerSchema to list the available attribute keys and what each one returns.

GET

api

external

buyer

{buyerId}

attributes

Get Buyer Attributes in bulk

curl --request GET \
  --url https://dashboard.starbridge.ai/api/external/buyer/{buyerId}/attributes \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://dashboard.starbridge.ai/api/external/buyer/{buyerId}/attributes"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

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

fetch('https://dashboard.starbridge.ai/api/external/buyer/{buyerId}/attributes', 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/buyer/{buyerId}/attributes",
  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/buyer/{buyerId}/attributes"

	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/buyer/{buyerId}/attributes")

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

{
  "buyerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "buyerData": {}
}

Authorizations

Authorization

string

header

required

HTTP Bearer Authentication

Path Parameters

buyerId

string

required

Query Parameters

attribute

enum<string>[]

The attribute keys to retrieve. Pass multiple attribute parameters for multiple keys, or omit entirely to return all available attributes. Each key is a BuyerField value; getBuyerSchema lists them with what each one returns.

Available options:

Id,

Name,

CommonName,

ParentName,

ParentBuyerId,

Type,

Classifications,

Url,

LinkedinSlug,

Zip,

CountryCode,

StateCode,

StateName,

City,

County,

Address,

Street1,

Street2,

MainPhoneNumber,

EmailDomains,

Population,

PopulationTrend,

PopulationOneYearChangePercentage,

PopulationFiveYearChangePercentage,

PopulationDensityPerSquareMile,

CountyHudAssistedHousingUnitCount,

HudAreaMedianFamilyIncome,

CountyMedicareAdvantageEnrollmentCount,

CountyMedicareAdvantagePenetrationPercentage,

CountyMedicareMedicaidEnrolleeCount,

CountyOriginalMedicareEnrollmentCount,

FemaDisasterDeclarationCount,

FemaFireDisasterDeclarationCount,

FemaFloodDisasterDeclarationCount,

FemaSevereStormDisasterDeclarationCount,

FemaWinterStormDisasterDeclarationCount,

BudgetAmount,

BudgetSbita,

BudgetUrl,

BudgetLatestYear,

BudgetConfidence,

SchoolDistrictType,

HigherEdFullTimeEnrollment,

HigherEdInstitutionType,

DepartmentName,

DepartmentCode,

AgencyName,

OfficeCodeArray,

AgencyCode,

AiAdoptionScore,

AiAdoptionSummary,

StartupFriendlinessScore,

StartupFriendlinessSummary,

ProcurementHellScore,

AngelProcurementSummary,

IpedsIdNumeric,

TotalEnrollment,

NcesId,

NcesStateDistrictId,

CensusIdPid6,

CensusIdGidId,

SgcId,

HigherEdGraduationRate,

HigherEdRetentionRate,

HigherEdAcceptanceRate,

HigherEdYieldRate,

HigherEdGraduationEnrollment,

HigherEdUndergradEnrollment,

HigherEdOnlineOnlyEnrollment,

HigherEdControlOfInstitution,

HigherEdForProfitStatus,

HigherEdLevelOfInstitution,

HigherEdRecruitmentAdmissionsCrmArray,

HigherEdEndowment,

HigherEdTotalExpenses,

HigherEdMascot,

HigherEdNumberOfOnCampusResidents,

HigherEdNumberOfFullTimeEmployees,

HigherEdSisModernizationStatus,

HigherEdPrimaryRegionalAccreditor,

HigherEdAccreditationSummary,

HigherEdAccreditationStatus,

DapipId,

HigherEdNextAccreditationReviewDate,

HigherEdSystem,

CommunityCollegeSystem,

HigherEdContinuingProfessionalEducationOffered,

Sis,

LmsArray,

SchoolDistrictLocale,

SchoolDistrictFullTimeEquivalentTeachers,

LowestGradeOffered,

HighestGradeOffered,

SchoolYearStartDate,

SchoolYearEndDate,

SchoolDistrictNumberOfSchools,

SchoolDistrictNewlyOpenedSchoolCount,

SchoolDistrictClosedSchoolCount,

SchoolDistrictElementarySchools,

SchoolDistrictMiddleSchools,

SchoolDistrictHighSchools,

SchoolDistrictTotalStaff,

SchoolDistrictMedianHouseholdIncome,

SchoolDistrictSector,

RegionalEducationServiceAgencyName,

RegionalEducationServiceAgencyBuyerId,

SchoolManagementOrganizationName,

SchoolManagementOrganizationBuyerId,

EnglishLearners,

BlackPercentage,

LatinoPercentage,

WhitePercentage,

StudentTeacherRatio,

SchoolSector,

SchoolLevel,

AlternativeSchool,

SchoolCurriculumProgramArray,

ReligiousAffiliation,

StudentGenderComposition,

SchoolVirtualStatus,

Subentity,

FiscalYearStartDate,

FreeOrReducedLunchEligiblePercentage,

FdId,

FireDepartmentType,

FireDepartmentOrganizationType,

FireDepartmentPrimaryAgency,

FireDepartmentNumberOfStations,

FireDepartmentActiveFirefightersCareer,

FireDepartmentActiveFirefightersVolunteer,

FireDepartmentActiveFirefightersPaidPerCall,

FireDepartmentNonFirefightingCivilian,

FireDepartmentNonFirefightingVolunteer,

PoliceOri,

PoliceOfficerCt,

PoliceDepartmentType,

HasCampusPolice,

Psap,

StateAgencySector,

EmployeeFte,

WaterSystemPopulationServed,

SpecialDistrictResidentPopulationEstimate,

MotorCarrierPowerUnits,

PropensityToSpendScore,

PropensityToSpendSummary,

BudgetChangeAnalysisSourceUrls,

PropensityToSpend,

YoyChangeInEnrollment,

EnrollmentTrend,

EnrollmentTrendBasedOnFte,

AtsiDesignation,

SpecialEducationEnrollment,

SpecialEducationEnrollmentPercentage,

TsiDesignation,

CsiDesignation,

SchoolDistrictTotalRevenue,

SchoolDistrictFederalRevenue,

SchoolDistrictStateRevenue,

SchoolDistrictLocalRevenue,

PerPupilExpenditure,

MathProficiencyPercentage,

ElaProficiencyPercentage,

GraduationRatePercentage,

ChronicAbsenteeismPercentage,

MathProficiencyStatePercentile,

ElaProficiencyStatePercentile,

TitleIFunding,

TitleIiFunding,

TitleIiiFunding,

TitleIvFunding,

TitleVFunding,

FederalGrantComplianceRisk,

FederalGrantComplianceCapSummary,

ErateFunding,

IhbgFinalAllocationAmount,

TribalTransportationProgramShare,

BuyerLocationLatitude,

BuyerLocationLongitude,

StarbridgeUrl

Response

Requested attribute values keyed by BuyerField name, wrapped in BuyerAttributesBulkResponse.

buyerId

string<uuid>

required

buyerData

object | null

Map of BuyerField attribute key to its value. A value is null when that attribute is not set on the buyer.

⌘I

Get Buyer Attributes in bulk

curl --request GET \
  --url https://dashboard.starbridge.ai/api/external/buyer/{buyerId}/attributes \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://dashboard.starbridge.ai/api/external/buyer/{buyerId}/attributes"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

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

fetch('https://dashboard.starbridge.ai/api/external/buyer/{buyerId}/attributes', 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/buyer/{buyerId}/attributes",
  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/buyer/{buyerId}/attributes"

	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/buyer/{buyerId}/attributes")

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

{
  "buyerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "buyerData": {}
}