GET
/
api
/
enterprise
/
opportunities
curl --request GET \
  --url https://app.govly.com/api/enterprise/opportunities \
  --header 'X-API-KEY: <api-key>'
{
  "id": "<string>",
  "aiEstimatedValueMax": 123,
  "aiEstimatedValueMin": 123,
  "aiLineItems": {
    "products": [
      {
        "vendor": "<string>",
        "product": "<string>",
        "quantity": 123,
        "description": "<string>",
        "partNumber": "<string>"
      }
    ],
    "services": [
      {
        "vendor": "<string>",
        "service": "<string>",
        "quantity": 123,
        "description": "<string>",
        "partNumber": "<string>"
      }
    ]
  },
  "aiPeriodOfPerformance": "<string>",
  "aiRawCompetingProducts": [
    "<string>"
  ],
  "aiRawCompetingVendors": [
    {
      "name": "<string>",
      "website": "<string>"
    }
  ],
  "aiRawProducts": [
    "<string>"
  ],
  "aiRawVendors": [
    {
      "name": "<string>",
      "website": "<string>"
    }
  ],
  "aiSummary": "<string>",
  "aiTitle": "<string>",
  "attachments": [
    {
      "checksum": "<string>",
      "filename": "<string>",
      "url": "<string>"
    }
  ],
  "buyer": {
    "id": "<string>",
    "hierarchy": [
      "<string>"
    ],
    "hierarchyIds": [
      "<string>"
    ],
    "name": "<string>"
  },
  "contractVehicle": "<string>",
  "displayName": "<string>",
  "externalIdentifier": "<string>",
  "identifier": "<string>",
  "lastSummarizedAt": "<string>",
  "uniqueKey": "<string>",
  "url": "<string>",
  "modifiedAt": "<string>"
}
BETA This endpoint is currently in development and may change in the future.

Request

ids[]
string[]
required

Array of opportunity IDs to retrieve

Response

Returns an array of opportunity objects with detailed information about each opportunity.

id
string

Unique identifier for the opportunity

aiEstimatedValueMax
float

Maximum estimated value of the opportunity in USD

aiEstimatedValueMin
float

Minimum estimated value of the opportunity in USD

aiLineItems
object

Structured breakdown of products and services mentioned in the opportunity

aiPeriodOfPerformance
string

Description of the performance period for the opportunity

aiRawCompetingProducts
string[]

Array of competing product names identified in the opportunity

aiRawCompetingVendors
object[]

Array of competing vendor information

aiRawProducts
string[]

Array of primary product names mentioned in the opportunity

aiRawVendors
object[]

Array of primary vendor information

aiSummary
string

AI-generated summary of the opportunity

aiTitle
string

AI-generated descriptive title

attachments
object[]

Array of documents attached to the opportunity

buyer
object

Information about the buying organization

contractVehicle
string

Contract vehicle being used for the opportunity

displayName
string

Human-readable identifier for the opportunity

externalIdentifier
string

External reference number for the opportunity

identifier
string

Internal reference number

lastSummarizedAt
string

ISO 8601 timestamp of when the opportunity was last processed by AI

uniqueKey
string

Unique identifier key for the opportunity

url
string

Web URL for viewing the opportunity

modifiedAt
string

ISO 8601 timestamp of the last modification

Example Request

curl "https://api.govly.com/api/enterprise/opportunities?ids[]=13887036"