Get Opportunity
Everything about one procurement record in a single call: the full untruncated summary, the buyer and its parent, the seller it was awarded to, the amounts and dates, the source files behind it, and the purchase-order line items parsed out of them. Call it with an opportunityId from searchOpportunities, researchBuyerFiles, or an RFP signal’s row.entity.id from listSignals. For an RFP signal, this response’s rfpIds are the source RFP IDs to pass to getRfp; one opportunity may contain several RFPs.
files[] carries each source file’s fileId — pass it to viewFileContents for the extracted text, or to getFileDownloadLinks for the original bytes. Only a file in Processed status has readable text. lineItems[] is the per-line detail of the purchase orders bundled into the opportunity, oldest first and drawn from at most 200 purchase orders; it is empty for an opportunity with none; its per-line purchaseAmount is in whole currency units, the same unit as the opportunity’s own purchaseAmount. Set includeFiles=false or includeLineItems=false when you only need the record — the line-item lookup in particular costs an extra round trip.
status is Future while untilDate is still ahead, Past once it has gone by, which is how you tell an open RFP from a closed one. buyer.id is the handle for everything about the buyer itself: getBuyerSummary, getBuyerAccountContext, searchBuyerContacts, researchBuyerFiles. For line items across several opportunities at once, call getOpportunityLineItems instead of this tool per id.
Authorizations
HTTP Bearer Authentication
Path Parameters
Query Parameters
Whether to include the source files. Set false when you only need the record.
Whether to include parsed purchase-order line items. Set false to skip an extra lookup.
Response
The opportunity with its files and line items
Document type. Selling is the wire name for an RFP
Selling, PurchaseOrder, Contract, SalesProposal, BoardMeeting, StrategicPlan, CapitalImprovementPlan, AnnualFinancialReport, BoardMeetingAgenda, BoardMeetingAgendaPacket, ProposedBudget, Budget, BudgetAmendment Parent of the buyer, when the buyer sits under one (a district over a school)
When Starbridge ingested the opportunity
When Starbridge last updated the opportunity
Starbridge dashboard link that opens this opportunity. Give it to the user when they ask for a link to the opportunity; sourceUrl fields point at the buyer's original documents instead.
Full summary of the document — not truncated, unlike the one searchOpportunities returns
Parent of the buyer, when the buyer sits under one (a district over a school)
Seller the opportunity was awarded to, for a purchase order or contract
Name of the seller the opportunity was awarded to
Purchase amount in whole currency units, when the document carries one
One-time cost extracted from the document
Recurring annual cost extracted from the document
Past or Future, derived from untilDate — Future means the deadline has not passed
Future, NextTwoYears, NextYear, NextNineMonths, NextSixMonths, NextThreeMonths, NextTwoMonths, NextOneMonth, NextSixtyDays, NextThirtyDays, NextSevenDays, NextOneDay, Present, LastOneDay, LastSevenDays, LastThirtyDays, LastSixtyDays, LastOneMonths, LastTwoMonths, LastThreeMonths, LastSixMonths, LastNineMonths, LastYear, LastTwoYears, Past Ids of the RFP records bundled into this opportunity
Ids of the purchase-order records bundled into this opportunity
Source files behind the opportunity. Null when includeFiles=false
Purchase-order line items parsed from the files, oldest first, from at most 200 purchase orders. Null when includeLineItems=false, empty when the opportunity has no parsed purchase orders. purchaseAmount here is in whole currency units, like the opportunity's own purchaseAmount.