Skip to main content
POST
List all contacts with pagination

Authorizations

token
string
header
required

Body

application/json
limit
integer
default:100

Maximum number of results per page (default 100, maximum 1000)

Required range: 1 <= x <= 1000
offset
integer
default:0

Zero-based offset for pagination

contactScope
enum<string>
default:address_book

Defines whether the search returns only contacts in the address book, only those outside it, or all known contacts.

Available options:
address_book,
outside_address_book,
all

Response

Contact list retrieved successfully

contacts
object[]
totalDeviceContacts
integer

Raw total of contacts on the device

pagination
object