SunchatPlus

Listar usuários

Lista usuários (somente leitura, exclui usuários removidos) com filtros e paginação

GEThttps://api-publica.sunchat.com.br/v1/usuarios
curl --request GET \
  --url 'https://api-publica.sunchat.com.br/v1/usuarios?search=&nome=&email=' \
  --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
emailstring
ativoboolean
idPerfilDeAcessostring<uuid>
idstring<uuid>
pageinteger<int32>
pageSizeinteger<int32>
sortstring

Resposta 200

OK
Itemsobject[] | null
Idstring<uuid>
Nomestring | null
Emailstring | null
Telefonestring | null
Ativoboolean
IdPerfilDeAcessostring<uuid> | null
Perfilstring | null
Administradorboolean
AssinaturaTicketstring | null
Atributosobject[] | null
Pageinteger<int32>
PageSizeinteger<int32>
TotalItemsinteger<int64>
TotalPagesinteger<int32>
HasNextboolean
HasPreviousboolean