API Docs
Voxbi Cockpit APIs
All endpoints

Get a Queue

Returns the queue identified by the path parameter. Multi-tenant scoping is enforced: the caller can only fetch resources within their own PBX.

No authentication required
id path · string · uuid *
accept header · string
example: application/json

Responses

Response schema
id*string · uuid
Queue identifier
read-only
example: 550e8400-e29b-41d4-a716-446655440000
pbx_id*string · uuid
Pbx identifier (tenant) that owns this queue
example: 550e8400-e29b-41d4-a716-446655440001
name*string
Human-readable name of the queue
length: 0–128
example: Customer Support
ring_strategy*string
Order in which queue members are rung when a call arrives. `ring_all` rings every member at once; `round_robin` cycles through members in turn; `least_recent` favours the member idle the longest; `fewest_calls` favours the member who has taken the fewest calls; `random` picks at random.
enum: fewest_calls least_recent round_robin ring_all random
example: ring_all
ring_busy_members*boolean
Whether members already on a call are still rung for new queue calls
example:
ring_duration*integer · int32
Seconds to ring a member before moving on to the next; -1 means unlimited
≥ -1
example: 20
interval*integer · int32
Seconds to wait between successive ring attempts (0 means no wait)
≥ 0
example: 5
wrap_up_time*integer · int32
Seconds an agent stays unavailable after finishing a queue call (0 means no wait)
≥ 0
example: 30
exit_keystring | null
DTMF key a waiting caller can press to leave the queue and follow the attached call flow. Null when no exit key is configured.
enum: 0 1 2 3 4 5 6 7 8 9 * #
example: 0
ring_empty*boolean
Whether callers may enter (and the queue keeps ringing) even when no members are available
example:
enable_caller_position*boolean
Whether waiting callers hear periodic announcements of their position in the queue
example:
caller_position_announce_frequency*integer · int32
How often, in seconds, a waiting caller's position and/or estimated hold time is announced
≥ 0
example: 10
caller_position_language*string
Language used for the caller position announcement
enum: en de fr
example: en
music_on_holdstring | null · uuid
Identifier of the sound file (of type `music`) played to callers while they wait. Null when no music-on-hold is configured.
example: 550e8400-e29b-41d4-a716-446655440004
users*array<object>
Queue member users, ordered by the tenant's configured name preference. Each item is a User resource. The array is empty when no users are assigned to the queue.
Each item — PBX user. Each user belongs to exactly one Pbx, owns optional extensions and devices, and carries a large set of feature flags controlling what they can do in the Voxbi UI and on the telephony stack. Secrets and credentials are never exposed through the API. Relation keys are opt-in via `?include=`.
id*string · uuid
User identifier
read-only
example: 550e8400-e29b-41d4-a716-446655440000
pbx_id*string · uuid
Pbx identifier (tenant)
example: 550e8400-e29b-41d4-a716-446655440001
first_name*string
length: 0–64
example: Jane
last_namestring | null
length: 0–64
example: Smith
namestring
Combined display name (accessor, respects PBX formatting settings)
read-only
example: Jane Smith
full_name_with_emailstring
Convenience label combining the display name and email
read-only
example: Jane Smith <jane.smith@example.com>
email*string · email
length: 0–100
example: jane.smith@example.com
status*string
enum: enabled disabled
example: enabled
typestring
User category
enum: user pickup_line
example: user
languagestring
Preferred UI language
enum: en de fr
example: en
sync_sourcestring
Provisioning origin
enum: manual provision legacy_import microsoft_entra
example: manual
vipboolean
Whether the user is flagged as VIP
example:
show_in_address_bookboolean
Whether the user appears in the shared address book
example: 1
default_caller_identity_idstring | null · uuid
Default outbound CID for this user
example: 550e8400-e29b-41d4-a716-446655440004
caller_identity_internal_extension_idstring | null · uuid
Extension shown as the internal caller ID
example: 550e8400-e29b-41d4-a716-446655440002
caller_identity_external_extension_idstring | null · uuid
Extension shown as the external caller ID
example: 550e8400-e29b-41d4-a716-446655440003
allow_telephonyboolean
Whether the user can place and receive calls
example: 1
allow_call_forwardingboolean
example: 1
allow_change_twinning_destboolean
Whether the user may change their twinning destination
example: 1
allow_dndboolean
Whether the user may set their own Do Not Disturb
example: 1
allow_status_changerboolean
Whether the user may change other users' statuses
example:
allow_anonymous_callsboolean
Whether the user is allowed to place anonymous outbound calls
example:
allow_international_callsboolean
example:
allow_eu_callsboolean
example: 1
allow_national_callsboolean
example: 1
allow_premium_numbersboolean
example:
allow_smsboolean
example:
allow_manage_global_contactsboolean
example:
allow_manage_voicemail_parametersboolean
example: 1
allow_in_call_recordingboolean
Whether the user can start/stop recording during a call
example:
allow_default_pbxes_outgoing_phone_numbersboolean
Whether the PBX default outbound numbers are usable by this user
example: 1
allow_grafana_accessboolean
Whether the user can access the Grafana dashboards
example:
allow_right_to_disconnectboolean
Whether the user may set their own right-to-disconnect schedule
example: 1
right_to_disconnectboolean
Whether the right-to-disconnect rule is currently enforced
example:
concurrent_callsboolean
Whether the user may have multiple simultaneous calls
example: 1
extension_roamingboolean
Whether the user may hot-desk by logging into other devices
example: 1
record_your_callsboolean
Default per-call recording flag for outbound external calls
example:
record_your_internal_callsinteger
Tri-state flag controlling internal-call recording (0 = off, 1 = on, 2 = follow PBX default). Stored as an integer despite the boolean-style name.
example: 2
access_all_call_recordingsboolean
Whether the user may access call recordings of others
example:
call_recordings_visibilitystring
enum: all_calls own_calls_only
example: own_calls_only
call_information_visibilitystring
enum: none own_calls own_group_only
example: own_calls
send_missed_call_via_emailboolean
example: 1
limit_email_missed_call_to_directboolean
Whether missed-call emails are limited to directly-dialled calls
example:
show_caller_id_for_twinning_callinteger
Tri-state flag controlling caller-ID display on twinning calls (0 = off, 1 = on, 2 = follow PBX default).
example: 2
voicemail_typestring
Voicemail mode
enum: disabled enabled internal external
example: internal
voicemail_destinationstring
Where voicemail notifications are sent
enum: email_only email_and_phone
example: email_only
invited_atstring | null · date-time
When the user was invited (if onboarding via invitation)
accepted_invitation_atstring | null · date-time
When the user accepted their invitation
email_verified_atstring | null · date-time
read-only
example: 2024-02-15T10:00:00Z
created_atstring | null · date-time
read-only
example: 2024-03-01T08:29:07Z
updated_atstring | null · date-time
read-only
example: 2024-03-01T08:29:07Z
extensionsarray<object>
Extensions owned by the user. Returned only when requested via `?include=extensions`.
Each item — Internal dial number assigned to a user, device, queue, or other PBX entity. Per-direction call recording is controlled by the two `record_*_calls` flags. The assignment is exposed as a friendly `assigned_to_type` + `assigned_to_id` (always present); the full `assigned_to` object is opt-in.
id*string · uuid
Extension identifier
read-only
example: 550e8400-e29b-41d4-a716-446655440000
pbx_id*string · uuid
Pbx identifier (tenant)
example: 550e8400-e29b-41d4-a716-446655440001
assigned_to_typestring | null
Friendly type of the entity this extension is assigned to
enum: user sip_device famulor_agent
example: user
assigned_to_idstring | null · uuid
Identifier of the entity this extension is assigned to
example: 550e8400-e29b-41d4-a716-446655440002
external_call_flow_idstring | null · uuid
Call flow applied to external inbound calls hitting this extension
example: 550e8400-e29b-41d4-a716-446655440003
internal_call_flow_idstring | null · uuid
Call flow applied to internal calls hitting this extension
example: 550e8400-e29b-41d4-a716-446655440004
number*string
Dialable extension digits
length: 0–16
example: 1337
namestring | null
Display name for the extension
example: Support line
descriptionstring | null
length: 0–255
example: Front-line support line
record_external_callsboolean
Whether external calls on this extension are recorded
example: 1
record_internal_callsboolean
Whether internal calls on this extension are recorded
example:
sync_sourcestring
Provisioning origin (cast to ExtensionSyncSource)
enum: manual provision legacy_import
example: manual
full_name_with_extension_numberstring | null
Convenience label combining the assignee's name and the extension number
read-only
example: Jane Smith (1337)
assigned_toobject
The resolved owner of this extension; shape varies by `assigned_to_type`. Returned only when requested via `?include=user` (or `?include=sipDevice` / `?include=famulorAgent`).
Free-form object
employee_idstring | null · uuid
Identifier of the employee record linked to the assigned user. Returned only when requested via `?include=user.employee`.
example: 550e8400-e29b-41d4-a716-446655440005
department_idstring | null · uuid
Department of the assigned user's employee, taken from their currently active contract (null when the employee has no active contract). Returned only when requested via `?include=user.employee`.
example: 550e8400-e29b-41d4-a716-446655440006
is_favoriteboolean
Whether the extension's user is one of the **calling user's** favourites. PRINCIPAL-CONDITIONAL: returned only for user-owned (Bearer) tokens and OMITTED entirely for PBX API-key tokens (a PBX has no per-user favourites).
example:
created_atstring | null · date-time
read-only
example: 2024-03-01T08:29:07Z
updated_atstring | null · date-time
read-only
example: 2024-03-01T08:29:07Z
groupsarray<object>
Groups the user belongs to. Returned only when requested via `?include=groups`.
Each item — Group of users that share routing defaults and (optionally) a common caller identity. Many fields are foreign keys pointing at defaults used when the group's users place or receive calls.
id*string · uuid
Group identifier
read-only
example: 550e8400-e29b-41d4-a716-446655440000
pbx_id*string · uuid
Pbx identifier (tenant)
example: 550e8400-e29b-41d4-a716-446655440001
default_internal_call_flow_idstring | null · uuid
Call flow used for internal calls reaching this group
example: 550e8400-e29b-41d4-a716-446655440002
default_external_call_flow_idstring | null · uuid
Call flow used for external calls reaching this group
example: 550e8400-e29b-41d4-a716-446655440003
extension_id_shown_outside_the_groupstring | null · uuid
Extension displayed to non-group members
example: 550e8400-e29b-41d4-a716-446655440005
default_caller_identity_idstring | null · uuid
Default caller identity applied to the group's outbound calls
example: 550e8400-e29b-41d4-a716-446655440004
external_uidstring | null
External identifier from a CRM or directory sync
example: grp-support
allow_call_pickupsboolean
Whether group members may pick up each others' ringing calls
example: 1
name*string
length: 0–64
example: Support team
descriptionstring | null
length: 0–255
example: First-line support
allow_default_pbxes_outgoing_phone_numbersboolean
Whether the group's CIDs include the PBX-default outbound numbers
example:
display_tab_to_everyone_inside_voxbiboolean
Whether the group's tab is shown to everyone in the PBX
example:
created_atstring | null · date-time
read-only
example: 2024-03-01T08:29:07Z
updated_atstring | null · date-time
read-only
example: 2024-03-01T08:29:07Z
usersarray<object>
Members of the group, each as a user reference. Returned only when requested via `?include=users`.
idstring · uuid
read-only
example: 550e8400-e29b-41d4-a716-446655440006
first_namestring | null
example: Jane
last_namestring | null
example: Smith
emailstring | null · email
example: jane.smith@example.com
allow_manage_group_contactsarray<object>
Groups whose contacts the user may manage. Returned only when requested via `?include=allowManageGroupContacts`.
Each item — Group of users that share routing defaults and (optionally) a common caller identity. Many fields are foreign keys pointing at defaults used when the group's users place or receive calls.
id*string · uuid
Group identifier
read-only
example: 550e8400-e29b-41d4-a716-446655440000
pbx_id*string · uuid
Pbx identifier (tenant)
example: 550e8400-e29b-41d4-a716-446655440001
default_internal_call_flow_idstring | null · uuid
Call flow used for internal calls reaching this group
example: 550e8400-e29b-41d4-a716-446655440002
default_external_call_flow_idstring | null · uuid
Call flow used for external calls reaching this group
example: 550e8400-e29b-41d4-a716-446655440003
extension_id_shown_outside_the_groupstring | null · uuid
Extension displayed to non-group members
example: 550e8400-e29b-41d4-a716-446655440005
default_caller_identity_idstring | null · uuid
Default caller identity applied to the group's outbound calls
example: 550e8400-e29b-41d4-a716-446655440004
external_uidstring | null
External identifier from a CRM or directory sync
example: grp-support
allow_call_pickupsboolean
Whether group members may pick up each others' ringing calls
example: 1
name*string
length: 0–64
example: Support team
descriptionstring | null
length: 0–255
example: First-line support
allow_default_pbxes_outgoing_phone_numbersboolean
Whether the group's CIDs include the PBX-default outbound numbers
example:
display_tab_to_everyone_inside_voxbiboolean
Whether the group's tab is shown to everyone in the PBX
example:
created_atstring | null · date-time
read-only
example: 2024-03-01T08:29:07Z
updated_atstring | null · date-time
read-only
example: 2024-03-01T08:29:07Z
usersarray<object>
Members of the group, each as a user reference. Returned only when requested via `?include=users`.
idstring · uuid
read-only
example: 550e8400-e29b-41d4-a716-446655440006
first_namestring | null
example: Jane
last_namestring | null
example: Smith
emailstring | null · email
example: jane.smith@example.com
allow_access_to_group_contactsarray<object>
Groups whose contacts the user may access. Returned only when requested via `?include=allowAccessToGroupContacts`.
Each item — Group of users that share routing defaults and (optionally) a common caller identity. Many fields are foreign keys pointing at defaults used when the group's users place or receive calls.
id*string · uuid
Group identifier
read-only
example: 550e8400-e29b-41d4-a716-446655440000
pbx_id*string · uuid
Pbx identifier (tenant)
example: 550e8400-e29b-41d4-a716-446655440001
default_internal_call_flow_idstring | null · uuid
Call flow used for internal calls reaching this group
example: 550e8400-e29b-41d4-a716-446655440002
default_external_call_flow_idstring | null · uuid
Call flow used for external calls reaching this group
example: 550e8400-e29b-41d4-a716-446655440003
extension_id_shown_outside_the_groupstring | null · uuid
Extension displayed to non-group members
example: 550e8400-e29b-41d4-a716-446655440005
default_caller_identity_idstring | null · uuid
Default caller identity applied to the group's outbound calls
example: 550e8400-e29b-41d4-a716-446655440004
external_uidstring | null
External identifier from a CRM or directory sync
example: grp-support
allow_call_pickupsboolean
Whether group members may pick up each others' ringing calls
example: 1
name*string
length: 0–64
example: Support team
descriptionstring | null
length: 0–255
example: First-line support
allow_default_pbxes_outgoing_phone_numbersboolean
Whether the group's CIDs include the PBX-default outbound numbers
example:
display_tab_to_everyone_inside_voxbiboolean
Whether the group's tab is shown to everyone in the PBX
example:
created_atstring | null · date-time
read-only
example: 2024-03-01T08:29:07Z
updated_atstring | null · date-time
read-only
example: 2024-03-01T08:29:07Z
usersarray<object>
Members of the group, each as a user reference. Returned only when requested via `?include=users`.
idstring · uuid
read-only
example: 550e8400-e29b-41d4-a716-446655440006
first_namestring | null
example: Jane
last_namestring | null
example: Smith
emailstring | null · email
example: jane.smith@example.com
sip_devicesarray<object>
SIP devices assigned to the user. Returned only when requested via `?include=sipDevices`.
Each item — Physical or soft SIP endpoint (deskphone, softphone, ATA, trunk) registered against the PBX. The device owner is exposed as a friendly `target_type` (`user` / `extension`) plus `target_id`; the full `target` object is opt-in. The SIP password is never exposed.
id*string · uuid
SIP device identifier
read-only
example: 550e8400-e29b-41d4-a716-446655440000
pbx_id*string · uuid
Pbx identifier (tenant)
example: 550e8400-e29b-41d4-a716-446655440001
target_typestring | null
Friendly type of the entity the device is assigned to
enum: user extension
example: user
target_idstring | null · uuid
Identifier of the target entity
example: 550e8400-e29b-41d4-a716-446655440003
extension_id_shown_for_internal_callsstring | null · uuid
Extension displayed in the device's caller ID for internal calls
roaming_user_idstring | null · uuid
User currently roamed onto this device
location_idstring | null · uuid
Physical location the device is installed at
example: 550e8400-e29b-41d4-a716-446655440002
parent_sip_device_idstring | null · uuid
Parent device (e.g. a Gigaset base) for handset child devices
name*string
length: 0–128
example: Reception desk phone
descriptionstring | null
length: 0–255
example: Front-desk Yealink T46U
is_enabled*boolean
Whether the device is currently enabled
example: 1
ip_internalstring | null
Last-seen internal IP
example: 192.168.1.42
ip_externalstring | null
Last-seen external IP
example: 203.0.113.10
user_agentstring | null
SIP User-Agent string reported by the device
example: Yealink SIP-T46U 108.86.0.10
macstring | null
MAC address
example: 00:0a:95:9d:68:16
vlan_phoneinteger | null
VLAN id for the phone interface
example: 100
vlan_pcinteger | null
VLAN id for the PC pass-through interface
example: 200
sip_usernamestring | null
SIP authentication username
length: 0–24
example: device_001
alt_usernamestring | null
Alternate SIP username (used for multi-line registrations)
transportstring
SIP transport
enum: udp tcp tls
example: tls
type*string
Device provisioning category
enum: auto manual gigaset trunk
example: auto
allow_roamingboolean
Whether the device accepts roamed-in users
example:
languagestring
Display language for the device
example: en
easy_deploystring | null · date-time
Timestamp until which the device is in easy-deploy mode
notifystring | null · date-time
Timestamp at which a SIP NOTIFY was last requested
allow_default_pbxes_outgoing_phone_numbersboolean
Whether the PBX default outbound numbers are usable from this device
example:
sync_sourcestring
Provisioning origin
enum: manual provision legacy_import
example: provision
custom_provisioningstring | null
Custom provisioning template snippet
last_seenstring | null · date-time
Last time the device registered
example: 2024-03-01T08:29:07Z
created_atstring | null · date-time
read-only
example: 2024-03-01T08:29:07Z
updated_atstring | null · date-time
read-only
example: 2024-03-01T08:29:07Z
targetobject
The resolved device owner (a user or an extension); shape varies by `target_type`. Returned only when requested via `?include=target`.
Free-form object
tagsarray<object>
Tags attached to this device. Returned only when requested via `?include=tags`.
Each item — Free-form label that can be attached to users, SIP devices, phone numbers, and other tenant resources for grouping, filtering, and reporting. Tags are scoped to a single Pbx (tenant). Associations to the resources a tag is applied to are held on the relevant pivot tables, not on this schema.
id*string · uuid
Unique tag identifier (UUID), assigned by the server on creation.
read-only
example: 550e8400-e29b-41d4-a716-446655440000
pbx_id*string · uuid
Identifier of the Pbx (tenant) that owns this tag. Tags are never shared across tenants.
read-only
example: 550e8400-e29b-41d4-a716-446655440001
name*string
Human-readable label for the tag, shown in dropdowns and used when filtering tagged resources.
length: 0–64
example: VIP Customers
descriptionstring | null
Optional free-text note explaining the purpose of the tag. Null when no description was provided.
length: 0–255
example: Customers with priority routing and dedicated agents.
created_atstring | null · date-time
Timestamp (ISO 8601, UTC) when the tag was created.
read-only
example: 2024-03-01T08:29:07Z
updated_atstring | null · date-time
Timestamp (ISO 8601, UTC) when the tag was last modified.
read-only
example: 2024-03-01T08:29:07Z
caller_identitiesarray<object>
Caller identities available to this device. Returned only when requested via `?include=callerIdentities`.
[]object
Free-form object
locationobject
The resolved installation location. Returned only when requested via `?include=location`.
twinningsarray<object>
Twinnings configured for the user. Returned only when requested via `?include=twinnings`.
Each item — Twinning: an external destination that rings alongside a user's extension (a mobile phone or a Microsoft Teams endpoint). When a call reaches the user, the twinned destination rings in parallel so the call can be answered away from the desk phone. Tenant scoping is derived from the attached user; this resource has no direct `pbx_id` column of its own.
id*string · uuid
Unique identifier of the twinning.
read-only
example: 550e8400-e29b-41d4-a716-446655440000
user_id*string · uuid
Identifier of the user this twinning belongs to. The user also determines the PBX tenant this twinning is scoped to.
example: 550e8400-e29b-41d4-a716-446655440001
status*string
Whether the twinning is active. Only an enabled twinning rings alongside the user's extension.
enum: enabled disabled
example: enabled
phone_number*string | null
The twinned destination phone number, stored in E.164 format. Null when the twinning targets a Teams endpoint or has no number configured.
example: +12125550100
delay*integer · int32
Number of seconds to wait after the call starts before the twinning leg begins ringing. A value of 0 means it rings immediately.
≥ 0
example: 5
sync_source*string
Origin of this twinning record. `manual` was created by a user, `provision` came from an automated provisioning step, and `legacy_import` was migrated from a previous system.
enum: manual provision legacy_import
example: manual
type*string
Channel used to reach the twinned destination, either a mobile phone or a Microsoft Teams endpoint.
enum: mobile teams
example: mobile
dial_strategy*string
How the mobile leg is dialed: `gsm_only` uses the cellular network only, `voip_only` uses the VoIP app only, and `voip_and_gsm_fallback` tries VoIP first and falls back to GSM. Only meaningful for mobile-type twinnings that use the Fixed-Mobile Convergence (FMC) integration.
enum: gsm_only voip_only voip_and_gsm_fallback
example: voip_and_gsm_fallback
fmc_enabled*boolean
Whether Fixed-Mobile Convergence (FMC) is enabled for this twinning, allowing seamless handover between VoIP and the cellular network.
example:
backup_phone_number*string | null
Secondary phone number, in E.164 format, dialed when the primary FMC leg cannot be reached. Null when no backup is configured.
example: +12125550101
created_atstring | null · date-time
Timestamp when the twinning was created (ISO 8601, UTC).
read-only
example: 2024-03-01T08:29:07Z
updated_atstring | null · date-time
Timestamp when the twinning was last updated (ISO 8601, UTC).
read-only
example: 2024-03-01T08:29:07Z
caller_identitiesarray<object>
Effective (inherited) caller identities for the user: own plus those of the user's groups plus the PBX's. Returned only when requested via `?include=callerIdentities`.
[]object
Free-form object
locationsarray<object>
Locations the user is associated with. Returned only when requested via `?include=locations`.
Each item — Physical office or site associated with a PBX. Locations form a nested-set tree via `parent_id` + `lft`/`rgt`/`depth`. Street-level address fields are used for emergency call routing.
id*string · uuid
Location identifier
read-only
example: 550e8400-e29b-41d4-a716-446655440000
pbx_id*string · uuid
Pbx identifier (tenant)
example: 550e8400-e29b-41d4-a716-446655440001
company_idstring | null · uuid
Owning company identifier
example: 550e8400-e29b-41d4-a716-446655440004
parent_idstring | null · uuid
Parent location identifier in the nested-set tree
example: 550e8400-e29b-41d4-a716-446655440002
name*string
length: 0–64
example: Luxembourg HQ
descriptionstring | null
length: 0–255
example: Main office, 5th floor
street_nostring | null
Street number portion of the address
example: 12
streetstring | null
example: Main Street
citystring | null
example: Luxembourg
postalstring | null
Postal code
example: 1234
country_idstring | null · uuid
Country identifier
example: 550e8400-e29b-41d4-a716-446655440003
lftinteger | null
Nested-set left bound
example: 1
rgtinteger | null
Nested-set right bound
example: 10
depthinteger | null
Tree depth (0 for root locations)
example: 0
enable_location_as_presence_statusboolean
Whether this location can be used as a presence status value
example:
styleobject | null
Optional presentation style (badge icon and colours) for the location
example: {"icon_class":"la-map-pin","bg_color":"#3490dc","font_color":"#ffffff"}
is_fixed_locationboolean
Whether this is a fixed (geofenced) physical location
example: 1
latitudenumber | null · float
Latitude of the location, in decimal degrees
example: 49.6116
longitudenumber | null · float
Longitude of the location, in decimal degrees
example: 6.1319
geofence_radius_minteger | null
Geofence radius around the location, in metres
example: 100
created_atstring | null · date-time
read-only
example: 2024-03-01T08:29:07Z
updated_atstring | null · date-time
read-only
example: 2024-03-01T08:29:07Z
languagesarray<object>
Languages the user is associated with. Returned only when requested via `?include=languages`.
Each item — A language defined for the tenant, used to label sound files, voice prompts (IVR announcements), and per-user language preferences. Each language belongs to exactly one Pbx (tenant) and is identified by a free-text name.
id*string · uuid
Unique language identifier (UUID).
read-only
example: 550e8400-e29b-41d4-a716-446655440000
pbx_id*string · uuid
Identifier of the Pbx (tenant) that owns this language.
read-only
example: 550e8400-e29b-41d4-a716-446655440001
name*string
Human-readable language name as shown in the cockpit and selectors.
length: 0–64
example: English
created_atstring | null · date-time
Timestamp (ISO 8601, UTC) when the language was created. Null if not set.
read-only
example: 2024-03-01T08:29:07Z
updated_atstring | null · date-time
Timestamp (ISO 8601, UTC) when the language was last updated. Null if not set.
read-only
example: 2024-03-01T08:29:07Z
tagsarray<object>
Tags attached to the user. Returned only when requested via `?include=tags`.
Each item — Free-form label that can be attached to users, SIP devices, phone numbers, and other tenant resources for grouping, filtering, and reporting. Tags are scoped to a single Pbx (tenant). Associations to the resources a tag is applied to are held on the relevant pivot tables, not on this schema.
id*string · uuid
Unique tag identifier (UUID), assigned by the server on creation.
read-only
example: 550e8400-e29b-41d4-a716-446655440000
pbx_id*string · uuid
Identifier of the Pbx (tenant) that owns this tag. Tags are never shared across tenants.
read-only
example: 550e8400-e29b-41d4-a716-446655440001
name*string
Human-readable label for the tag, shown in dropdowns and used when filtering tagged resources.
length: 0–64
example: VIP Customers
descriptionstring | null
Optional free-text note explaining the purpose of the tag. Null when no description was provided.
length: 0–255
example: Customers with priority routing and dedicated agents.
created_atstring | null · date-time
Timestamp (ISO 8601, UTC) when the tag was created.
read-only
example: 2024-03-01T08:29:07Z
updated_atstring | null · date-time
Timestamp (ISO 8601, UTC) when the tag was last modified.
read-only
example: 2024-03-01T08:29:07Z
queuesarray<object>
Queues the user is a member of. Returned only when requested via `?include=queues`.
[]object
Free-form object
Authorization Token Missing. This error is returned when the authorization token is missing.
Response schema
errorstring
Error message
example: Authorization Token is missing
Data Not Found. This error is returned when the requested data is not found.
Response schema
messagearray<string>
[]string
Server error. An unexpected condition was encountered on the server and the request could not be completed. The body is a generic JSON envelope with a `message` field. The response is logged on the server side; quote the request URL + timestamp when reporting an issue.
Response schema
messagestring
exceptionstring
Only present in non-production environments.
filestring
Only present in non-production environments.
lineinteger
Only present in non-production environments.
get https://cockpit.voxbi.com/api/v1/queues/{id}
Base URL
Request sample 
curl -X GET 'https://cockpit.voxbi.com/api/v1/queues/{id}'
const response = await fetch('https://cockpit.voxbi.com/api/v1/queues/{id}', {
  method: 'GET',
  headers: {
    'Content-Type': 'application/json',
  },
});

const data = await response.json();
console.log(data);
import requests

response = requests.get('https://cockpit.voxbi.com/api/v1/queues/{id}')
response.raise_for_status()
data = response.json()
print(data)
<?php
$context = stream_context_create([
    'http' => [
        'method'  => 'GET',
        'header'  => "Content-Type: application/json",
    ],
]);

$response = file_get_contents('https://cockpit.voxbi.com/api/v1/queues/{id}', false, $context);
$data = json_decode($response, true);
print_r($data);
No example for this status.
Host string
example: cockpit.voxbi.com
Date string
example: Mon, 16 Oct 2023 14:08:48 GMT
Connection string
example: close
Cache-Control string
example: no-cache, private
Content-Type string
example: application/json
X-RateLimit-Limit integer
example: 60
X-RateLimit-Remaining integer
example: 59
Vary string
example: Origin
{ … }
"error": "Authorization Token is missing"
}
Cache-Control string
example: private, must-revalidate
Connection string
example: keep-alive
Content-Type string
example: application/json
Vary string
example: Origin
X-RateLimit-Limit integer
Max requests allowed in the current rate-limit window.
example: 60
X-RateLimit-Remaining integer
Requests remaining in the current rate-limit window.
example: 57
{ … }
"message": [ … ]
"Data not found"
]
}
Cache-Control string
example: private, must-revalidate
Connection string
example: keep-alive
Content-Type string
example: application/json
Vary string
example: Origin
X-RateLimit-Limit integer
Max requests allowed in the current rate-limit window.
example: 60
X-RateLimit-Remaining integer
Requests remaining in the current rate-limit window.
example: 57
{ … }
"message": "Server Error"
}