solarOS Organization API

ssolarOS API
Go to app
Organization API

Get one Campaign

Returns one Campaign by solarOS id inside the authenticated organization boundary with External References. Required scope: campaigns:read.

/api/v1/campaigns/{id}

Returns one Campaign by solarOS id inside the authenticated organization boundary with External References. Required scope: campaigns:read.

Get one Campaign. Use an organization API key with campaigns:read. Check the response envelope and meta.requestId before triggering dependent workflow steps.

Required scopes

campaigns:read

Parameters

NameInTypeDescription
idrequiredpathstringCampaign identifier returned by the Organization API.

Request body

This endpoint does not accept a JSON request body.

Responses

200

Campaign detail envelope

#/components/schemas/CampaignEnvelope

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: campaigns:read

#/components/schemas/OrgApiError

404

Campaign 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: campaigns:read404 Campaign not found429 Rate limit exceeded

Static examples

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