List studios
const url = 'https://api.caller9.app/v1/organizations/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/studios';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://api.caller9.app/v1/organizations/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/studios \ --header 'Authorization: Bearer <token>'Lists the organization’s studios, oldest first.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Organization ID (UUID). Must be the organization that owns the API key.
Responses
Section titled “Responses”Studios.
object
A studio and its configuration. Boolean settings are returned as integers (0 / 1). Returned by
GET/PATCH /v1/studios/{studio} and by the organization studio list/create endpoints.
object
Studio ID.
Owning organization ID.
Number used as outbound caller ID, if set.
Outbound caller ID name (CNAM-normalized).
Busy / Do-Not-Disturb is on.
Act as Do-Not-Disturb when no operator has the studio open.
Seconds before the ring-timeout action (5–60).
Ring time for hotline calls, in seconds (5–60).
AI assistant used for screening.
AI screening capability is enabled.
Number of on-air hybrid SIP endpoints.
Every inbound call is screened by the AI assistant.
Contest Mode capability is enabled.
A contest is currently armed.
Default winning caller number (1–110).
Default number of backup winners (0–100).
Default post-contest window in seconds (10–3600).
Text-to-speech greeting text.
TTS voice ID; null means the platform default voice.
Storage key of the uploaded greeting file, if any.
Storage key of the cached synthesized TTS greeting, if any.
Maximum voicemail length in seconds (5–600).
Record a message after the greeting.
Ring-timeout forwarding destination type.
Set when forward_dest_type is sip.
E.164 number; set when forward_dest_type is phone.
Selected library track; null means the platform default.
Storage key of the uploaded custom Music on Hold file, if any.
Creation timestamp (ISO 8601).
Last update timestamp (ISO 8601).
Always null for studios returned by the API.
Example
{ "studios": [ { "busy_all": 0, "auto_dnd_when_empty": 0, "ai_screening_enabled": 0, "screen_all": 0, "contest_enabled": 0, "contest_mode": 0, "ring_timeout_action": "none", "voicemail_greeting_type": "tts", "voicemail_record_message": 0, "email_voicemails_enabled": 0, "delete_after_email": 0, "forward_dest_type": "sip", "moh_mode": "library" } ]}Missing, invalid, expired or revoked API key.
object
Human-readable error message.
Machine-readable code (authentication failures only, e.g. KEY_EXPIRED, RATE_LIMITED).
Example generated
{ "error": "example", "code": "example"}Not found, or belongs to another organization.
object
Human-readable error message.
Machine-readable code (authentication failures only, e.g. KEY_EXPIRED, RATE_LIMITED).
Example generated
{ "error": "example", "code": "example"}Too many requests for this API key. Retry after Retry-After seconds.
object
Human-readable error message.
Machine-readable code (authentication failures only, e.g. KEY_EXPIRED, RATE_LIMITED).
Example generated
{ "error": "example", "code": "example"}Headers
Section titled “Headers”Seconds until the rate-limit window resets.