Skip to main content
GET
List VoiceLink clients

Authorizations

Authorization
string
header
required

API key in format: rg_live_xxxx. Pass as a Bearer token in the Authorization header.

Query Parameters

connection_id
string<uuid>

Optional unless multiple active VoiceLink connections exist.

VoiceLink client search term.

status
integer

VoiceLink client status filter.

per_page
integer

VoiceLink page size.

Required range: x >= 1
page
integer

VoiceLink page number.

Required range: x >= 1

Response

VoiceLink clients response.

A VoiceLink upstream response wrapped in the V2 success envelope. The data shape is forwarded from VoiceLink and may vary by endpoint.

success
boolean
required
data
required

VoiceLink upstream response body.