---
title: "Read Phone Templates available to a Domain"
method: GET
path: "/domains/{domain}/phonetemplates"
tags: ["SnapBuilder/Phone Templates"]
---

# Read Phone Templates available to a Domain

`GET /domains/{domain}/phonetemplates`

## Request

- Base URL: `https://ns-api.com/ns-api/v2`
- URL: `https://ns-api.com/ns-api/v2/domains/{domain}/phonetemplates`
- Auth: HTTP bearer

## Path parameters

- `domain` string, required: This is the main organization name. This is used to link resource to its group/tenant/organization/enterprise. Then using in path for GET you can set to "~" to use the domain name linked to your token/key instead of the domain name itself when reading for your own domain.

## Response `200`

- Phoneconfiguration[]
  - `phoneconfiguration-name` string: This is the main name for the phone configuration when used as a template
  - `phoneconfiguration-mac-address` string: When phone configuration is applied to a specific phone (not template) this will be a valid mac
  - `phoneconfiguration-description` string, required: This is a plain description of the configuration
  - `phoneconfiguration-brand` string, required: The brand for which this phone configuration will be build for.
  - `phoneconfiguration-model` string, required: The model specific to brand for which this phone configuration will be build for.
  - `phoneconfiguration-domain` string, required: The domain owning this phone configuration
  - `phoneconfiguration-sidecars` object[], nullable: List of "sidecars" for the phone if in use. Use multiple if multiple side car's in use.
    - `phoneconfiguration-brand` string: This is the brand for sidecar specifically. It likely will match the parent phoneconfiguration-brand setting.
    - `phoneconfiguration-model` string: This is the model specifically for the sidecar unit, it will be different to the model listed at the root level.
  - `phoneconfiguration-extra` object: This is an "extra" object that will be used for easy expansion when needed later. Available optional declerations will be defined below.
    - `dynamic` string: dynamic can be set to true if this is being used in dynamic BLF settings.
  - `phoneconfiguration-directory` object
    - `group` string: This is the name of the Directory data set. It could be the like of "All", "Coworkers" or a specific entry like the name of a Department.
    - `group-type` string: This is the type of contacts to use, "Standard" or "department"
    - `sort` 'Extension' | 'First Name' | 'Last name': This is the label to use to sort the directory
    - `order` 'asc' | 'desc': This is the sort direction for the directory
    - `exclusions` object[]: List of excluded entries for the domain
      - `id` string: The uid of the user being excluded from the directory.
      - `type` string: The type of contact, most will be "onnet"
  - `phoneconfiguration-buttons` PhoneConfigBtn[]
    - `phoneconfiguration-button-order` integer, required: This is the button order, It will increment from the first button and will continue through all the sidecar buttons.
    - `phoneconfiguration-button-type` string, required: Type of button that will link to the NDP server's building of the button. Needs to match oiptions available in vendor/model.
    - `phoneconfiguration-button-feature` string, required: This is the main feature type. Common ones inlcude line, blf, park,speed_dial, queue_status, timeframe_status
    - `phoneconfiguration-button-target` union: This is the main setting mapping the resouce to the button. example would be the extension or queue name in many cases.
      - string
      - integer
      - boolean
      - unknown[]
        - unknown
      - object
      - number
    - `phoneconfiguration-button-label` string: Any lable override will go here if wish to change/force the text to be displayed.
    - `phoneconfiguration-button-locked` integer, nullable, required: If wanting to lock a button from editing by UI, set to 1.
    - `phoneconfiguration-extra` object, nullable: optional set of extra params.
      - `timeframe` string: timeframe used in timeframe features
      - `targetUser` string: targetUser in cases where editing another user.
      - `dynamic` boolean: Set to true for dynamic BLF
  - `last-modified-datetime` string: The last updated timestamp for the config

## Other responses

- `400`
- `401`
- `404`

## Changes

- **2026-11-03** `bce16087d479`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/ns-api/apis/netsapiens-api-v2/changes/domains/:domain/phonetemplates/get.md)

---

[API](https://skmtc.dev/ns-api/apis/netsapiens-api-v2.md) - [All operations](https://skmtc.dev/ns-api/apis/netsapiens-api-v2/llms.txt) - [OpenAPI document](https://skmtc.dev/ns-api/apis/netsapiens-api-v2/revisions/bce16087d479?raw)