# Get connection

`GET /v1/voximplant-sip/:configId`

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

GET /v1/voximplant-sip/:configId calls voximplant.sip.get with FILTER.CONFIG_ID. configId is a positive integer. No connection for this APP_ID: 404 ENTITY_NOT_FOUND.

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 |
|---|---|---|---|
| configId | integer | yes | Positive connection ID from [SIP list](/docs/voximplant-sip/list). |

## Response fields

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

## Examples

### cURL Personal key

```bash
curl -X GET 'https://vibecode.bitrix24.com/v1/voximplant-sip/15' \
  -H 'X-Api-Key: FAKE_VIBE_API_KEY'
```

### cURL OAuth

```bash
curl -X GET 'https://vibecode.bitrix24.com/v1/voximplant-sip/15' \
  -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/15', {
  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/15', {
  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 |
| 404 | ENTITY_NOT_FOUND |

[Error reference](/docs/errors)

403 when the key has no telephony scope:

```json
{
  "success": false,
  "error": {
    "code": "SCOPE_DENIED",
    "message": "This endpoint requires 'telephony' scope"
  }
}
```

## See also

[Calls](/docs/calls)

[SIP](/docs/voximplant-sip)