Get the organization

Read your organization: name, default language and time zone, deployment capabilities, and the settings in effect (defaults included), such as how many outbound calls may run at once, who is emailed when the AI escalates a conversation or fails in it and how often (each notice at once, or a digest every few hours), and the daily report. capabilities.managedVoiceOutbound reports whether the shared outbound line is configured; settings.channels.managedVoiceOutboundEnabled is the organization's separate permission to use it.

Scopes: any one of raiz:organization:read, raiz:organization:write
Credentials: an API key, a client-credentials token or a person's access token
Effect: read-only; safe to retry
Limits: response up to 1 MB
CLI: arbol raiz organization get · MCP tool: raiz_organization_get

GET

https://api.getarbol.com/v1/raiz/organization

Authorization

Authorization
string
required
Bearer <token>, where the token is an API key, a client-credentials token or a person's access token with any one of the scopes raiz:organization:read, raiz:organization:write. Get an API key.

Returns

200

Successful operation.

JSON

success
boolean
required
data
object
required
- capabilities
  object
  required
  managedVoiceOutbound
  boolean
  required
  Whether this deployment has a configured shared outbound line. Agents in the platform voice workspace may use it while settings.channels.managedVoiceOutboundEnabled is true. This does not verify provider service health.
- createdAt
  string
  required
  An instant in RFC 3339 format, in UTC.
  
  format: date-time
- id
  string
  required
  Verified organization identifier.
  
  pattern: ^[A-Za-z0-9][A-Za-z0-9_-]{0,127}$
- language
  string
  required
  Default language of the organization's Agents (BCP 47).
- name
  string
  required
- settings
  object
  required
  channels
  object
  required
  managedVoiceOutboundEnabled
  boolean
  required
  Whether Agents without a line of their own may call out from the platform's shared number (default true).
  
  maxConcurrentOutboundCalls
  integer
  required
  Campaign calls the organization places at once (default 5). The scheduler starts new ones only into free slots.
  
  minimum: 1
  dailyReport
  object
  required
  enabled
  boolean
  required
  Email the daily report every day at sendAt, in the organization's time zone: the calls and conversations registered in the last 24 hours, the conversations waiting for the team and those that need a review (default true). A day without activity sends nothing.
  
  recipients
  array of
  string
  required
  Additional recipients for the daily report alongside eligible workspace owners, at most 10 addresses (default none). It lists the contacts of calls and conversations by name and number: choose recipients who may read the organization's conversations.
  
  format: email · maxLength: 254
  sendAt
  string
  required
  The local time the daily report goes out, HH:MM in 24 hours (default 18:00). Moving it later the same day sends nothing more that day; turning the report on after the day's time sends that day's report at once.
  
  pattern: ^([01][0-9]|2[0-3]):[0-5][0-9]$
  notifications
  object
  required
  escalations
  boolean
  required
  Email the recipients, and send the phones a WhatsApp message, when the AI hands a conversation to the team: it escalates a request it cannot resolve, the contact asks for a person, or the Agent's monthly budget is spent (default true).
  
  failedOutcomes
  boolean
  required
  Email the recipients when the analysis of a closed conversation concludes that the contact's request was not resolved (outcome failure). A conversation closed for inactivity never counts (default true).
  
  failures
  boolean
  required
  Email the recipients when the AI could not answer: a WhatsApp reply that ended with the fallback message, or a call that failed or in which one of the Agent's functions failed (default true).
  
  frequency
  immediate
  or
  hourly
  or
  every3Hours
  or
  every6Hours
  or
  every12Hours
  required
  How often the notices reach the team (default immediate). immediate sends each notice as it happens, one email per conversation; a failure that repeats is notified once when its cause first appears, and the conversations the same cause touches in the next hour go out together an hour later, one follow-up an hour while it lasts. hourly, every3Hours, every6Hours and every12Hours send one digest at the end of each window of that length, counted from local midnight in the organization's time zone (every six hours: 00:00, 06:00, 12:00 and 18:00), listing the conversations that still need the team; the escalation's WhatsApp message follows the same schedule. A window without notices sends nothing.
  
  phones
  array of
  string
  required
  Who also receives the escalation notice by WhatsApp, at most 10 numbers in E.164 (default none). The message names the Agent, the organization and why the conversation was handed over, with a link to it; never the contact, the summary or the transcript. The other notices go by email only.
  
  pattern: ^\+[1-9][0-9]{7,14}$
  recipients
  array of
  string
  required
  Additional recipients for team notices alongside eligible workspace owners, at most 10 addresses (default none). An email carries the conversation's link, channel, times, Agent and state, its title and summary and the analysis' evaluations; never the transcript or the captured data. A summary may name the person: choose recipients who may read the organization's conversations.
  
  format: email · maxLength: 254
  whatsapp
  object
  required
  maxConcurrentReplies
  integer
  required
  WhatsApp replies the organization's Agents write at once (default 20). A reply past it waits for the next scheduler tick, so a peak in one organization never slows the others.
  
  minimum: 1
  productNotices
  optional
  object
  events
  array of
  agent-idle
  or
  agent-live
  or
  budget-reached
  or
  budget-warning
  or
  campaign-finished
  or
  channel-disconnected
  +11 more
  required
  Product emails enabled for this organization. All are enabled unless the organization saves a selection. An empty selection turns all of them off.
  
  recipients
  array of
  string
  required
  format: email · maxLength: 254
  administrators
  array of
  string
  required
  format: email · maxLength: 254
- timeZone
  string
  required
  IANA time zone. Reports count days in it and campaigns default to it.
- updatedAt
  string
  required
  An instant in RFC 3339 format, in UTC.
  
  format: date-time
}
error
null
required
metadata
object
required
- requestId
  string
  required
  Request correlation identifier, also sent as X-Request-Id.
}

400

INVALID_INPUT: The request does not match the published schema.

JSON

error
required
One of the following:
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
}

401

UNAUTHORIZED: A valid access token is required.

JSON

error
required
One of the following:
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
}

403

FORBIDDEN: The token does not authorize this operation.

JSON

error
required
One of the following:
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
}

404

NOT_FOUND: The requested operation does not exist.
RESOURCE_NOT_FOUND: The requested resource does not exist in this organization.

JSON

error
required
One of the following:
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
}

405

HTTP_METHOD_NOT_ALLOWED: The HTTP method is not supported for this resource.

JSON

error
required
One of the following:
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
}

413

REQUEST_TOO_LARGE: The request exceeds the allowed size.

JSON

error
required
One of the following:
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
}

415

UNSUPPORTED_MEDIA_TYPE: The request content type is not supported.

JSON

error
required
One of the following:
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
}

429

RATE_LIMITED: The request rate limit was exceeded. Try again later.

JSON

error
required
One of the following:
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
}

500

INTERNAL_ERROR: The service could not complete the operation.

JSON

error
required
One of the following:
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
}

502

OUTCOME_UNKNOWN: The operation may have been applied; check its result before repeating it.

JSON

error
required
One of the following:
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
}

503

UPSTREAM_UNAVAILABLE: The upstream service could not complete the request.
INTEGRATIONS_UNAVAILABLE: The organization's integrations cannot be read right now. Try again shortly.

JSON

error
required
One of the following:
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
}

504

UPSTREAM_TIMEOUT: The upstream service did not respond before its deadline.

JSON

error
required
One of the following:
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
}