Saltar para o conteúdo principal
GET
cURL
Para pesquisar: informe o locationId e um dos campos: email ou phone. Se nenhum deles for informado, a API retorna erro 400. Os dois campos não devem ser enviados juntos.
Token e permissões: na Salez, acesse Configurações > Integrações Privadas para gerar ou gerenciar um token, conforme seu nível de acesso. Esta operação exige o escopo contacts.readonly. Envie Authorization: Bearer <token> e Version: v3. Consulte a visão geral de Contatos.

Autorizações

Authorization
string
header
obrigatório

Use um token autorizado da subconta. Gere ou gerencie a integração em Configurações > Integrações Privadas na Salez, conforme as permissões do usuário. Informe o token no formato Bearer.

Cabeçalhos

Version
string
obrigatório

Versão obrigatória da API: v3.

Parâmetros de consulta

locationId
string
obrigatório

ID da subconta.

Exemplo:

"ve9EPM428h8vShlRW1KT"

email
string

Informe um e-mail ou, alternativamente, um telefone. Um dos dois é obrigatório. Não preencha os dois simultaneamente.

Exemplo:

"sara@salez.com.br"

phone
string

Informe um telefone ou, alternativamente, um e-mail. Um dos dois é obrigatório. Não preencha os dois simultaneamente.

Exemplo:

"+5511934848735"

nextCursor
string

Cursor de paginação retornado pela API.

limit
integer

Quantidade por página, limitada a 20.

Exemplo:

20

Resposta

Resposta de sucesso.

contacts
object[]

Contatos encontrados.

nextCursor
string

Cursor opcional da próxima página.

Exemplo:

"eyJkYXRlQWRkZWQiOjE3MDAwMDAwMDAwMDAsImlkIjoiYy1sYXN0In0="

Última modificação em 20 de novembro de 2026