Listar contatos de um cliente

GET

/v2/queries/clients/{clientId}/contacts

Lista os endereços, e-mails e telefones coletados para o cliente informado em clientId. A resposta traz as listas addresses, emails e phones, que juntam contatos de mais de uma fonte e mostram uma vez só os que se repetem (endereços iguais no logradouro antes da primeira vírgula, na cidade, no estado e no CEP; e-mails iguais; telefones com o mesmo DDD e número). Um contato de uma das fontes traz id, o tipo e as informações de passagem (total_passages e last_passage); um da outra traz só os campos básicos: address, city, zip_code e state nos endereços, email nos e-mails, area_code e phone_number nos telefones. Cliente sem contatos devolve as três listas vazias. Requer autenticação via Bearer JWT ou header x-api-key.

Requisição

Authorization

Forneça seu token bearer no cabeçalho

Authorization

ao fazer requisições para recursos protegidos.

Exemplo:

Authorization: Bearer ********************

Parâmetros de Caminho

Parâmetros Header

Respostas

🟢200

application/json

Contatos do cliente

Bodyapplication/json

🟠400BadRequest

🟠401Unauthorized

🟠404NotFound

🟠429TooManyRequests

🔴500InternalError

Request Example

Shell

JavaScript

Java

Swift

curl --location '/v2/queries/clients/7c9e6679-7425-40de-944b-e07fc1f90ae7/contacts' \
--header 'x-api-key: SUA_CHAVE_DE_API' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Sucesso

{
    "addresses": [
        {
            "address": "RUA EXEMPLO, 100",
            "city": "SORRISO",
            "zip_code": "78890000",
            "state": "MT"
        },
        {
            "id": "b3c4d5e6-7f80-4a91-b2c3-d4e5f6a7b8c9",
            "address_type": "RESIDENTIAL",
            "country": "BRASIL",
            "state": "MT",
            "city": "SORRISO",
            "address": "AV EXEMPLO, 200",
            "zip_code": "78890001",
            "information": {
                "total_passages": 3,
                "last_passage": "2026-05-10T00:00:00"
            }
        }
    ],
    "emails": [
        {
            "email": "contato@example.com"
        },
        {
            "id": "c4d5e6f7-8091-4ba2-83d4-e5f6a7b8c9d0",
            "email": "financeiro@example.com",
            "type": "PERSONAL",
            "information": {
                "total_passages": 2,
                "last_passage": "2026-04-22T00:00:00"
            }
        }
    ],
    "phones": [
        {
            "area_code": "66",
            "phone_number": "999990000"
        },
        {
            "id": "d5e6f708-91a2-4cb3-94e5-f6a7b8c9d0e1",
            "area_code": "66",
            "phone_number": "999990001",
            "type": "MOBILE",
            "information": {
                "total_passages": 5,
                "last_passage": "2026-07-01T00:00:00"
            }
        }
    ]
}

Modificado em 2026-10-05 16:38:25

Página anterior

Consultar o resultado de uma flag de negativação

Próxima página

Consultar dados cadastrais de um cliente