solarOS Organization API

Organization API

Get one Customer

Returns one Customer by id inside the calling organization boundary. The response includes billingEmail; null falls back to the contact email for invoicing. Missing or inaccessible shared Customers return 404.

/api/v1/customers/{id}

Returns one Customer by id inside the calling organization boundary. The response includes billingEmail; null falls back to the contact email for invoicing. Missing or inaccessible shared Customers return 404.

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

Required scopes

customers:read

Parameters

NameInTypeDescription
idrequiredpathstringCustomer identifier returned by the Organization API.

Request body

This endpoint does not accept a JSON request body.

Responses

200

Customer 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: customers: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: customers:read404 Not found429 Rate limit exceeded

Static examples

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