Contatos

List All Contacts

Listar todos os contatos. Para buscar os contatos em qualquer horário necessário passar os parametros "createdAtFrom" e "createdAtTo" com uma diferença de até 2 horas. Exemplo: /contacts/all?createdAtFrom=2024-08-01T00:00:00.000Z&createdAtTo=2024-08-01T02:00:00.000Z

get/v3/contacts/all

Request

  • Base URL: https://api4.kinbox.com.br (the document declares no server; this is the origin it was published from)
  • URL: https://api4.kinbox.com.br/v3/contacts/all
  • Auth: HTTP bearer

Query parameters

last48hboolean required

Contato está na primeira sessão da primeira conversa

newContactboolean required

Contato está na primeira sessão da primeira conversa

Response

totalCountnumber

Total de registros

Example response

{
  "data": [
    {
      "name": "João Silva",
      "email": "joaosilva@gmail.com",
      "phone": "5585997281648",
      "customFields": {
        "cpf": {
          "value": "060.715.303-54"
        }
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 23 revisions of this API.