Skip to main content
POST
Listar todos os contatos com paginacao

Autorizações

token
string
header
obrigatório

Corpo

application/json
limit
integer
padrão:100

Quantidade maxima de resultados por pagina (padrao 100, maximo 1000)

Intervalo obrigatório: 1 <= x <= 1000
offset
integer
padrão:0

Deslocamento base zero para paginacao

contactScope
enum<string>
padrão:address_book

Define se a busca retorna apenas contatos da agenda, apenas fora da agenda ou todos os contatos conhecidos.

Opções disponíveis:
address_book,
outside_address_book,
all

Resposta

Lista de contatos recuperada com sucesso

contacts
object[]
totalDeviceContacts
integer

Total bruto de contatos no dispositivo

pagination
object