Skip to main content
GET
List Phone Numbers

Authorizations

Authorization
string
header
required

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

Query Parameters

tenantId
string
required

Tenant ID

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

Branch ID

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

Phone number

Maximum string length: 11
query
string

Search by number, comment, or name

Maximum string length: 255
fax
string

Search by fax (1 = yes, 0 = no)

inUse
enum<string>

Filter by use status (1 = in use, 0 = not in use)

Available options:
0,
1
sortBy
string

Sort column

Maximum string length: 50
sortDirection
enum<string>

Sort direction

Available options:
asc,
desc
limit
string

Number of results per page

Pattern: ^[1-9]\d*$
paginated
integer
default:1

1 = paginated response, 0 = full list

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

Page number

recordsPerPage
number

Records per page

Response

Paginated phone numbers

records
object[]
required

Phone number records

page
number
required

Current page

maxPage
number
required

Maximum page

totalRecords
number
required

Total records