Organization

Base URL: $BUSINESS_API

The object

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

The object
{
  "id": "org_2ZNeUPlw01Za6RbKMZDGGbR4cV5",
  "name": "Ana Matsinhe",
  "type": "utility",
  "status": "active",
  "utility_kind": "authority",
  "billing_mode": "account"
}

Get the authenticated utility profile

Logs

GET /organization

Returns the organization that owns the caller's tenant: its name, type, utility kind, billing mode and status. Requires the business:organization:read permission.

Returns

200 Utility organization and tenant settings

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

Permissions business:organization:read · Roles: admin, analyst, billing_clerk, customer_service, field_reader, field_supervisor, finance, operations, owner, viewer

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