Skip to main content
GET
List Phonebooks

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