---
title: "Get a SIP account"
method: GET
path: "/sip_accounts/{id}"
tags: ["SIP-Accounts"]
---

# Get a SIP account

`GET /sip_accounts/{id}`

## Request

- Base URL: `https://api.commpeak.com/portal`
- URL: `https://api.commpeak.com/portal/sip_accounts/{id}`
- Auth: API key in header `Authorization`

Returns one SIP account of the customer by its `id` (display token), with its settings, authentication and the Dynamic Caller ID rules assigned to it. Deleted accounts and accounts of other customers return 404.

## Path parameters

- `id` string, required: SIP account display token.

## Response `200`

Successful Response

- SipAccountResponse: Envelope returned by the single-SIP-account methods.
  - `sip_account` SipAccountItem, required: A single SIP account of the customer.
    - `id` string, required: SIP account display token (opaque identifier; not the SIP username).
    - `name` string, required: Human-readable name (empty string when unset).
    - `auth_method` string, required: Authentication method: `password` or `ip`.
    - `username` string, nullable: SIP username (only when `auth_method` is `password`).
    - `ip_acl` string[], nullable: IPs allowed to use the credentials (only when `auth_method` is `password`).
    - `jwt_enabled` boolean, nullable: Whether JWT signature authentication is enabled (only when `auth_method` is `password`).
    - `auth_ips` string[], nullable: Authenticated IPs (only when `auth_method` is `ip`).
    - `channel_limit` integer, required: Maximum concurrent channels (0 = unlimited up to the account limit).
    - `default_tech_prefix` string, nullable: Default tech prefix of the SIP account.
    - `out_of_balance_message` boolean, nullable: Whether a message is played to the callee when the account is out of balance.
    - `caller_id_fixing` boolean, nullable: Whether the Caller ID format is corrected automatically.
    - `auto_nat_fix` boolean, nullable: Whether the automatic NAT traversal fix is enabled.
    - `dynamic_caller_ids` integer[], nullable: Ids of the assigned Dynamic Caller ID rules (see `GET /portal/dynamic_caller_ids`).
    - `editable` boolean, nullable: False for accounts provisioned by CommPeak, whose authentication can't be changed.
    - `active` boolean, required: Whether the SIP account is provisioned and ready for use.

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/commpeak/apis/commpeak-portal-api.md) - [All operations](https://skmtc.dev/commpeak/apis/commpeak-portal-api/llms.txt) - [OpenAPI document](https://skmtc.dev/commpeak/apis/commpeak-portal-api/revisions/df57b0c16367?raw)