Skip to main content
GET
/
v2
/
admin
/
phonebooks
/
List Phonebooks
curl --request GET \
  --url https://api.voxo.co/v2/admin/phonebooks/ \
  --header 'Authorization: Bearer <token>'
{
  "records": [
    {
      "id": 123,
      "tenantId": 123,
      "name": "<string>",
      "includeExt": "<string>",
      "provisioning": 123
    }
  ],
  "page": 123,
  "maxPage": 123,
  "totalRecords": 123
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
paginated
integer
default:1

1 = paginated response, 0 = full list

Required range: 0 <= x <= 1
​
page
number

Page number

​
recordsPerPage
number

Records per page

​
tenantId
string
required

Tenant ID

Pattern: ^[1-9]\d*$
​
query
string

Filter by phonebook name (LIKE)

Maximum string length: 50

Response

Paginated phonebooks

​
records
object[]
required
​
page
number
required
​
maxPage
number
required
​
totalRecords
number
required