PT EN

Organizações: Organizações

URL base: $BUSINESS_API

Obter uma organização

Registos

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.

Parâmetros

organizationIDstring · caminho · obrigatório

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

Devolve

200 Organization profile

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

Erros 403

Permissões organization:accounts:read · Funções: account_admin, account_analyst, account_finance, account_owner, account_support

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