Skip to main content
POST
/
contacts
/
list
Listar todos os contatos com paginacao
curl --request POST \
  --url https://api.wppfy.com/contacts/list \
  --header 'Content-Type: application/json' \
  --header 'token: <api-key>' \
  --data '
{
  "page": 1,
  "pageSize": 100,
  "limit": 123,
  "offset": 0
}
'
{
  "contacts": [
    {
      "jid": "5511999999999@s.whatsapp.net",
      "contact_name": "Joao Silva",
      "contact_FirstName": "Joao"
    }
  ],
  "pagination": {
    "totalRecords": 123,
    "totalDeviceContacts": 123,
    "pageSize": 123,
    "currentPage": 123,
    "totalPages": 123,
    "hasNextPage": true,
    "hasPreviousPage": true
  }
}

Authorizations

token
string
header
required

Body

application/json
page
integer
default:1

Numero da pagina para paginacao (padrao 1)

pageSize
integer
default:100

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

limit
integer

Alias opcional para pageSize

offset
integer
default:0

Deslocamento base zero para paginacao; se informado recalcula a pagina

Response

Lista de contatos recuperada com sucesso

contacts
object[]
pagination
object