API : PBX : Phonebook group get
- Introduction
- Request
- Response
  - Example
  - Errors

API : PBX : Phonebook group get

Introduction

A phonebook group is a named group of phonebook contacts. Other features point at a group by its id, e.g. to route a call depending on whether the caller is in the group.

There are two kinds of groups:

Customer groups hold the customers shared contacts. Every user of the customer can see them. Access level MANAGER or above is required to create, rename and delete them.
Personal groups belong to one employee and hold that employees personal contacts. The employee manages them, and so does another employee who has the group right readPhonebook (to see them) or writePhonebook (to change them) on the employee.

A contact selects its groups through its groups property when it is created or updated. A shared contact can only be in customer groups, a personal contact only in the personal groups of its own employee.

This request returns a single group with the number of contacts in it. Use the phonebook list with the group query parameter to get the contacts.

Request

URL	https://api.telecomx.dk/pbx/phonebookgroup/GROUP_ID
Method	GET
Access level	Customer group: PERSONAL, VIEWER, MANAGER or OWNER if user belongs to the customer, RESELLER if customer belongs to the reseller, ADMIN. Personal group: the employee self, or an employee with the group right `readPhonebook` on the employee.
Param	GROUP_ID	Id of the group (24 hex-char string)

Response

Phonebook group object
_id	Id	Unique id of the group.
customer	Id	Id of the customer the group belongs to.
employee	Id	Id of the employee owning a personal group, null for a customer group.
name	String	Name of the group.
notes	String	Notes about what the group is used for, null if none.
contacts	Number	Number of contacts in the group.
createdAt	Date	When the group was created.
updatedAt	Date	When the group was last changed.

Example

{
  _id: '12345678901234567890ABCD',
  customer: '12345678901234567890AAAA',
  employee: null,
  name: 'VIP',
  notes: 'Customers who go straight to the account team',
  contacts: 12,
  createdAt: '2026-10-15T08:12:44.000Z',
  updatedAt: '2026-10-15T08:12:44.000Z'
}

Errors

Error code	Message	Description
403	access_denied	Insufficient access level
404	id	Phonebook group not found
422	id	Not a valid id
500	internal_error	<Unspecified>