Organizations: Organizations

Base URL: $BUSINESS_API

Read the authenticated organization profile and billing mode

Logs

GET /organizations/{organizationID}

Returns the organization record, including its status and billing mode, to staff signed in to that organization. The caller must be acting in an organization context whose ID matches the path and must hold the organization:accounts:read scope; otherwise the call returns 403.

Parameters

organizationIDstring · path · required

ID of the organization; it must equal the organization the caller is currently acting in, or the request is refused.

Returns

200 Organization profile

Show attributes
idstring · required
namestring · required
typestring · required

one of utility, authority, operator, regulator, partner, group

statusstring · required
utility_kindstring · optional

one of authority, municipal, regional, national, rural, private, industrial

billing_modestring · required

one of account, organization

Errors 403

Permissions organization:accounts:read · Roles: account_admin, account_analyst, account_finance, account_owner, account_support

curl -X GET "$BUSINESS_API/organizations/{organizationID}" \
  -H "Authorization: Bearer sk_test_..."
Response 200
{
  "id": "org_2ZNeUPlw01Za6RbKMZDGGbR4cV5",
  "name": "Ana Matsinhe",
  "type": "utility",
  "status": "active",
  "utility_kind": "authority",
  "billing_mode": "account"
}