Contatos

List Contacts

Changed on

Listar os contatos paginado

get/v3/contacts

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
  • Auth: HTTP bearer

Query parameters

emailExactstring

E-mail exato, sem diferenciar maiúsculas e minúsculas

searchstring

Busca por nome (mín. 3 letras), telefone, e-mail exato ou ID. Não retorna o total.

newContactboolean required

Contato está na primeira sessão da primeira conversa

organizationIdstring

Contatos vinculados à organização (ativa)

segmentIdstring

Segmento de conversa (inbox): contatos com alguma conversa cuja última sessão atende ao segmento

sessionCreatedAtFromstring

Última sessão de alguma conversa criada a partir desta data

sessionCreatedAtTostring

Última sessão de alguma conversa criada até esta data

sortField'createdAt' | 'name' | 'id'
sortOrder'ascend' | 'descend'
withOrganizationboolean

Inclui a organização principal (organization) e a quantidade de organizações (organizationsCount)

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

  • c083bbfe8973Revision changes
    • info

      added the new optional query request parameter emailExact

    • info

      added the new optional query request parameter organizationId

    • info

      added the new optional query request parameter search

    • info

      added the new optional query request parameter segmentId

    • info

      added the new optional query request parameter sessionCreatedAtFrom

    • info

      added the new optional query request parameter sessionCreatedAtTo

    • info

      added the new optional query request parameter sortField

    • info

      added the new optional query request parameter sortOrder

    • info

      added the new optional query request parameter withOrganization