Buscar contatos por texto

Buscar contatos (alias de listar)

GEThttps://api-publica.sunchat.com.br/v1/contatodechat/buscar

curl --request GET \
  --url 'https://api-publica.sunchat.com.br/v1/contatodechat/buscar?search=&nome=&telefone=' \
  --header 'X-Ambiente: SEU_NUMERO_DE_CONTA' \
  --header 'X-Authorization: X-Chave-Api SUA_CHAVE'

Autenticação

X-Ambientestring (header)obrigatório

Número da sua conta no SunchatPlus. Aceita também `X-Canal` com o ID de um canal, que resolve a conta a partir dele.

X-Authorizationstring (header)obrigatório

Chave de API no formato `X-Chave-Api {chave}`. O prefixo faz parte do valor. A chave fica em Minha conta › Integrações.

Parâmetros de consulta

searchstring

nomestring

telefonestring

emailstring

idPessoastring<uuid>

ehGrupoboolean

incluirExcluidosboolean

idsTagsstring<uuid>[]

pageinteger<int32>

pageSizeinteger<int32>

sortstring

Resposta 200

Itemsobject[] | null

Idstring<uuid>

Nomestring | null

Apelidostring | null

Telefonestring | null

Emailstring | null

ProfilePicUrlstring | null

EhGrupoboolean

IdPessoastring<uuid> | null

Observacaostring | null

IdsTagsstring<uuid>[] | null

Pageinteger<int32>

PageSizeinteger<int32>

TotalItemsinteger<int64>

TotalPagesinteger<int32>

HasNextboolean

HasPreviousboolean