Skip to navigation

Get

Returns information about the workspace. An API key must have workspace access.

Authentication

AuthorizationBearer

Bearer authentication header of the form Bearer <PHONIC_API_KEY>. Manage your API keys here.

Response

Success response
active_conversationsinteger>=0
Number of conversations currently in progress for this workspace.
max_active_conversationsinteger>=0
Maximum number of concurrent conversations allowed for this workspace.
active_agentsinteger>=0
Number of enabled agents in this workspace. Disabled and deleted agents, and agents in deleted projects, are not counted.
max_agentsinteger>=0
Maximum number of enabled agents allowed for this workspace.
logo_urlstring or null

URL of the workspace logo (PNG or SVG), or null if not set.

ip_allowlistlist of strings
IP addresses or CIDR ranges allowed to access the workspace.
alertsobject
Email alert recipients for the workspace, keyed by alert type.

Errors

401
Unauthorized Error
403
Forbidden Error
500
Internal Server Error