List connections

GET /v1/voximplant-sip

Scope: telephony | Authentication: X-Api-Key | URL: https://vibecode.bitrix24.com/v1

GET /v1/voximplant-sip calls voximplant.sip.get. Parameters: filter[configId], sort=configId, order=ASC|DESC, start=0. Native UPPER filter and sort fields are accepted. One Bitrix24 page; send meta.next as the next start. meta.total contains the upstream count when available. Passwords are replaced with presence flags.

Errors: 400 invalid parameters; 401 key or token; 403 scope, Bitrix24 permissions or READONLY writes; 422 upstream refusal; 429 limits; 502 unavailable Bitrix24 account; 503 timeout or freeze.

Request parameters

Field	Type	Required	Meaning
filter	object	no	Noncredential SIP fields only (for example configId, type, title, server, login); native operators and logical groups supported. Credential fields and relation paths return 400 before calling Bitrix24.
sort	string	no	Connection field; provide order together.
order	string	no	ASC or DESC; provide sort together.
start	integer	no	Nonnegative Bitrix24 page offset, default 0; next page from meta.next.

Response fields

Field	Meaning
success	Boolean result
data	Result described above; credentials are omitted

Examples

cURL Personal key

Terminal

curl -X GET 'https://vibecode.bitrix24.com/v1/voximplant-sip?start=0' \
  -H 'X-Api-Key: FAKE_VIBE_API_KEY'

cURL OAuth

Terminal

curl -X GET 'https://vibecode.bitrix24.com/v1/voximplant-sip?start=0' \
  -H 'X-Api-Key: FAKE_VIBE_API_KEY' \
  -H 'Authorization: Bearer FAKE_APP_SESSION_TOKEN'

JavaScript Personal key

javascript

const response = await fetch('https://vibecode.bitrix24.com/v1/voximplant-sip?start=0', {
  method: 'GET',
  headers: {"X-Api-Key": "FAKE_VIBE_API_KEY"},
});
console.log(await response.json());

JavaScript OAuth

javascript

const response = await fetch('https://vibecode.bitrix24.com/v1/voximplant-sip?start=0', {
  method: 'GET',
  headers: {"X-Api-Key": "FAKE_VIBE_API_KEY", "Authorization": "Bearer FAKE_APP_SESSION_TOKEN"},
});
console.log(await response.json());

Observed on the test account 2026-10-02; the example shows nonsecret response fields.

JSON

{
  "success": true,
  "data": [
    {
      "type": "office",
      "configId": "15",
      "title": "VIBE-PROBE MR5038",
      "hasPassword": true,
      "hasIncomingPassword": true
    }
  ]
}

Errors

HTTP	Code
400	INVALID_PARAMS / MISSING_REQUIRED_FIELDS / READONLY_FIELD
401	MISSING_API_KEY / INVALID_API_KEY / TOKEN_MISSING
403	SCOPE_DENIED / WRITE_BLOCKED_READONLY_KEY / BITRIX_ACCESS_DENIED
422	BITRIX_ERROR
429	RATE_LIMITED
502	BITRIX_UNAVAILABLE
503	BITRIX_TIMEOUT

Error reference

403 when the key has no telephony scope: