solarOS Organization API

Organization API

Get one Opportunity

Returns one organization-owned Opportunity, including opportunities that are Account-linked before a Property is mapped.

/api/v1/opportunities/{id}

Returns one organization-owned Opportunity, including opportunities that are Account-linked before a Property is mapped.

Get one Opportunity. 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

NameInTypeDescription
idrequiredpathstringOpportunity identifier returned by the Organization API.

Request body

This endpoint does not accept a JSON request body.

Responses

200

Opportunity envelope

#/components/schemas/OrgApiResourceEnvelope

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

404

Not found

#/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:read404 Not found429 Rate limit exceeded

Static examples

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