--- title: "/Opportunities" slug: "opportunities-5" updated: 2025-10-24T20:45:50Z published: 2025-10-24T22:08:46Z canonical: "guide.youraspire.com/opportunities-5" --- > ## Documentation Index > Fetch the complete documentation index at: https://guide.youraspire.com/llms.txt > Use this file to discover all available pages before exploring further. # /Opportunities Get/Opportunities SecurityHTTPType bearer Bearer Authorization Token Query parameters$selectstring $filterstring $expandstring $orderbystring $skipstring $topstring $pageNumberstring $limitstring api-versionstring Responses200Array of object object OpportunityIDinteger (int32) PropertyIDinteger (int32) | null OpportunityStatusIDinteger (int32) | null OpportunityStatusNamestring | null Min length0Max length100 SalesRepContactIDinteger (int32) | null SalesRepContactNamestring | null Min length0Max length101 OperationsManagerContactIDinteger (int32) | null OperationsManagerContactNamestring | null Min length0Max length101 DivisionIDinteger (int32) | null DivisionNamestring | null Min length0Max length50 BranchIDinteger (int32) | null BranchNamestring | null Min length0Max length50 SalesTypeIDinteger (int32) | null SalesTypeNamestring | null Min length0Max length30 TemplateOpportunityIDinteger (int32) | null LeadSourceIDinteger (int32) | null LeadSourceNamestring | null Min length0Max length75 MasterOpportunityIDinteger (int32) | null BillingAddressIDinteger (int32) | null BillingAddressLine1string | null Min length0Max length75 BillingAddressLine2string | null Min length0Max length75 BillingAddressCitystring | null Min length0Max length50 BillingAddressStateProvinceCodestring | null Min length0Max length3 BillingAddressZipCodestring | null Min length0Max length15 OpportunityTypestring | null Min length0Max length10 MasterSequenceNuminteger (int32) | null OpportunityNamestring | null Min length0Max length200 ProposalDescription1string | null Min length0Max length2147483647 StartDatestring (date-time) | null EndDatestring (date-time) | null BidDueDatestring (date-time) | null CreatedDateTimestring (date-time) | null ApprovedDatestring (date-time) | null ProposedDatestring (date-time) | null WonDatestring (date-time) | null LostDatestring (date-time) | null Probabilitynumber (decimal) | null AnticipatedCloseDatestring (date-time) | null InvoiceTypestring | null Min length0Max length35 CustomerContractNumstring | null Min length0Max length40 CustomerPONumstring | null Min length0Max length20 BudgetedDollarsnumber (decimal) | null EstimatedDollarsnumber (decimal) | null StateTaxPercentnumber (decimal) | null FederalTaxPercentnumber (decimal) | null CreatedByUserIDinteger (int32) | null CreatedByUserNamestring | null Min length0Max length101 ApprovedUserIDinteger (int32) | null ApprovedUserNamestring | null Min length0Max length101 ProposedUserIDinteger (int32) | null ProposedUserNamestring | null Min length0Max length101 ClosedUserIDinteger (int32) | null ClosedUserNamestring | null Min length0Max length101 CompetitorIDinteger (int32) | null CompetitorNamestring | null Min length0Max length100 LostReasonstring | null Min length0Max length50 BillingContactIDinteger (int32) | null BillingContactNamestring | null Min length0Max length101 ProposalDescription2string | null Min length0Max length2147483647 OpportunityNumberinteger (int32) | null EstimatedCostDollarsnumber (decimal) | null EstimatedOverheadDollarsnumber (decimal) | null EstimatedBreakEvenDollarsnumber (decimal) | null EstimatedNetProfitPercentnumber (decimal) | null EstimatedNetProfitDollarsnumber (decimal) | null EstimatedGrossMarginPercentnumber (decimal) | null EstimatedGrossMarginDollarsnumber (decimal) | null EstimatedLaborHoursnumber (decimal) | null EstimatedLaborCostPerHournumber (decimal) | null EstimatedRealizeRatenumber (decimal) | null EstimatedEquipmentCostnumber (decimal) | null EstimatedLaborCostnumber (decimal) | null EstimatedMaterialCostnumber (decimal) | null EstimatedOtherCostnumber (decimal) | null EstimatedSubCostnumber (decimal) | null ActualCostDollarsnumber (decimal) | null ActualGrossMarginPercentnumber (decimal) | null ActualGrossMarginDollarsnumber (decimal) | null ActualLaborHoursnumber (decimal) | null ActualLaborCostPerHournumber (decimal) | null ActualEarnedRevenuenumber (decimal) | null InvoiceNotestring | null Min length0Max length2147483647 PercentCompletenumber (decimal) | null RenewalDatestring (date-time) | null ModifiedByUserIDinteger (int32) | null ModifiedByUserNamestring | null Min length0Max length101 ModifiedDatestring (date-time) | null OverridePaymentTermsIDinteger (int32) | null OverridePaymentTermsstring | null Min length0Max length20 RetainagePercentnumber (decimal) | null EstimatorNotesstring | null Min length0Max length65535 ElectronicPaymentsOverrideConvenienceFeenumber (decimal) | null OpportunityCanceledReasonIDinteger (int32) | null OpportunityCanceledReasonstring | null Min length0Max length100 RetainageMaturityDatestring (date-time) | null DistrictNamestring | null Min length0Max length200 JobStatusNamestring | null Min length0Max length100 RegionNamestring | null Min length0Max length250 PaymentTermsIDinteger (int32) | null BillingCompanyIDinteger (int32) | null BillingCompanyNamestring | null Min length0Max length100 BranchCodestring | null Min length0Max length6 PropertyNamestring | null Min length0Max length100 DivisionCodestring | null Min length0Max length6 TaxablePercentnumber (decimal) | null TaxableAmountnumber (decimal) | null TMPerServiceTaxableAmountnumber (decimal) ActualCostSubnumber (decimal) | null ActualCostMaterialnumber (decimal) | null ActualCostLabornumber (decimal) | null CompleteDatestring (date-time) | null OpportunityRevisions Array of object (AspireCloud.Domain.Tenant.Opportunities.ODataModel.OpportunityRevision) | null object OpportunityRevisionIDinteger (int32) | null RevisionNumberinteger (int32) RevisionStatusstring | null Min length0Max length10 StartDatestring (date-time) CreatedDatestring (date-time) CreatedByUserIdinteger (int32) WonDatestring (date-time) | null WonByUserIdinteger (int32) | null OpportunityBillings Array of object (AspireCloud.Domain.Tenant.Opportunities.ODataModel.OpportunityBilling) | null object OpportunityBillingIDinteger (int32) OpportunityBillingRefIDinteger (int32) | null BillMonthinteger (int32) | null InvoiceDescriptionstring | null InvoiceTriggerPercentnumber (decimal) | null InvoiceAmountnumber (decimal) | null SortOrderinteger (int32) | null Activeboolean | null OpportunityRevisionIDinteger (int32) | null ScheduleOfValueGroups Array of object (AspireCloud.Domain.Tenant.Opportunities.ODataModel.ScheduleOfValueGroup) | null object Idinteger (int32) Namestring | null AvailableToInvoiceboolean SortOrderinteger (int32) ScheduleOfValues Array of object (AspireCloud.Domain.Tenant.Opportunities.ODataModel.ScheduleOfValue) | null object ScheduleOfValueIDinteger (int32) MasterOpportunityIDinteger (int32) | null LinkedToAServiceboolean ServiceIDinteger (int32) | null OpportunityServiceIDinteger (int32) | null Descriptionstring | null Quantitynumber (decimal) | null UnitPricenumber (decimal) | null TotalPricenumber (decimal) | null CreatedDateTimestring (date-time) CreatedByUserIDinteger (int32) CreatedByUserNamestring | null LastModifiedDateTimestring (date-time) | null LastModifiedByUserIDinteger (int32) | null Deletedboolean AvailableToInvoiceboolean SortOrderinteger (int32) OpportunityStageIDinteger (int32) | null OpportunityStagestring | null Min length0Max length50 OpportunityStageNamestring | null Min length0Max length100 OpportunityStatusstring | null Min length0Max length20 EstimatedTotalCostnumber (decimal) | null WonDollarsnumber (decimal) | null MasterOpportunityNumberinteger (int32) | null RealOpportunityNumberinteger (int32) | null