PT EN

Perfil da empresa

URL base: $BUSINESS_API

O objecto

idstring · obrigatório
namestring · obrigatório
typestring · obrigatório

um de utility, authority, operator, regulator, partner, group

statusstring · obrigatório
utility_kindstring · opcional

um de authority, municipal, regional, national, rural, private, industrial

billing_modestring · obrigatório

um de account, organization

Operações
O objecto
{
  "id": "org_2ZNeUPlw01Za6RbKMZDGGbR4cV5",
  "name": "Ana Matsinhe",
  "type": "utility",
  "status": "active",
  "utility_kind": "authority",
  "billing_mode": "account"
}

Obter o perfil da empresa

Registos

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.

Devolve

200 Utility organization and tenant settings

Mostrar atributos
idstring · obrigatório
namestring · obrigatório
typestring · obrigatório

um de utility, authority, operator, regulator, partner, group

statusstring · obrigatório
utility_kindstring · opcional

um de authority, municipal, regional, national, rural, private, industrial

billing_modestring · obrigatório

um de account, organization

Permissões business:organization:read · Funções: 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_..."
Resposta 200
{
  "id": "org_2ZNeUPlw01Za6RbKMZDGGbR4cV5",
  "name": "Ana Matsinhe",
  "type": "utility",
  "status": "active",
  "utility_kind": "authority",
  "billing_mode": "account"
}