Organization API

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.

/api/v1/opportunities

List Opportunities. Use an organization API key with opportunities:read. Check the response envelope and meta.requestId before triggering dependent workflow steps.

Required scopes

opportunities:read

Parameters

Name	In	Type	Description
limit	query	integer	Maximum records to return. Defaults to 50 and is capped at 100.
cursor	query	string	Opaque record cursor from the previous response meta.nextCursor value.
sortDir	query	asc \| desc	Sort direction. Defaults to desc.
stage	query	NEW \| PROPOSAL \| NEGOTIATION \| CLOSED_WON \| CLOSED_LOST	Filter by the current Opportunity stage.
customerId	query	string	Filter by Customer id.
propertyId	query	string	Filter by accessible Property id.
ownerId	query	string	Filter by owner Team Member id.
externalSystem	query	string	External Reference system filter. Supply with externalObject and externalId for exact reconciliation lookup.
externalObject	query	string	External Reference object filter. Supply with externalSystem and externalId.
externalId	query	string	External Reference id filter. Supply with externalSystem and externalObject.

Request body

This endpoint does not accept a JSON request body.

Responses

200

Opportunity list envelope

#/components/schemas/OrgApiListEnvelope

401

Missing or invalid organization API key

#/components/schemas/OrgApiError

402

Organization billing access or an endpoint-specific business quota denied the request

#/components/schemas/OrgApiError

403

Missing required scope: opportunities:read

#/components/schemas/OrgApiError

429

Rate limit exceeded

#/components/schemas/OrgApiError

Errors

401 Missing or invalid organization API key402 Organization billing access or an endpoint-specific business quota denied the request403 Missing required scope: opportunities:read429 Rate limit exceeded

Static examples

curl -X GET "$SOLAROS_BASE_URL/api/v1/opportunities" \
  -H "Authorization: Bearer $SOLAROS_API_KEY"