solarOSsolarOS Docs

List Opportunities

Lists Opportunities inside the organization and linked Property boundary. Supply externalSystem, externalObject, and externalId together to filter by a canonical External Reference. Required scope: opportunities:read.

GET
/opportunities

Lists Opportunities inside the organization and linked Property boundary. Supply externalSystem, externalObject, and externalId together to filter by a canonical External Reference. Required scope: opportunities:read.

Authorization

Authorization<token>

Organization API key. Format: Bearer sk_live_...

In: header

Query Parameters

limit?integer

Maximum records to return. Defaults to 50 and is capped at 100.

Range1 <= value <= 100
Default50
cursor?string

Opaque record cursor from the previous response meta.nextCursor value.

sortDir?string

Sort direction. Defaults to desc.

Default"desc"

Value in

  • "asc"
  • "desc"
stage?string

Filter by the current Opportunity stage.

Value in

  • "NEW"
  • "PROPOSAL"
  • "NEGOTIATION"
  • "CLOSED_WON"
  • "CLOSED_LOST"
customerId?string

Filter by Customer id.

propertyId?string

Filter by accessible Property id.

ownerId?string

Filter by owner Team Member id.

externalSystem?string

External Reference system filter. Supply with externalObject and externalId for exact reconciliation lookup.

externalObject?string

External Reference object filter. Supply with externalSystem and externalId.

externalId?string

External Reference id filter. Supply with externalSystem and externalObject.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/opportunities"
{  "data": [    {}  ],  "meta": {    "nextCursor": "string",    "hasMore": true,    "requestId": "string",    "version": "v1",    "timestamp": "2019-08-24T14:15:22Z",    "rateLimit": {      "limit": 0,      "remaining": 0,      "reset": 0    }  }}