Pular para o conteúdo principal
GET
curl

Visão geral

Retorna uma lista paginada de entidades de usuário da aplicação autenticada. Use este endpoint para sincronizar usuários ao seu data warehouse, encontrar usuários que precisam da atenção de um analista ou pesquisar pelo nome de exibição.

Quando usar

  • Sincronização periódica da sua tabela de usuários com uma ferramenta de BI ou um data warehouse externo.
  • Filas de análise: filtre por status=FLAGGED ou por last_activity_at desatualizado para alimentar uma caixa de entrada de revisão.
  • Pesquisa de usuários por display_name, full_name ou vendor_data.

Filtros e paginação

Observações

  • Cada item da resposta inclui didit_internal_id. vendor_data pode ser null quando a sessão ou a transação original não informou esse valor.
  • Este endpoint pagina por cursor: guarde o cursor next entre as chamadas e pare quando next estiver vazio.
  • Consulte o modelo de dados de usuário para ver todos os campos de um registro de usuário.

Permissões

Qualquer chave de API ativa da aplicação pode chamar este endpoint. As chaves de API da Didit têm escopo de aplicação, não de função: as funções e permissões do Console (list:users e as demais) definem o que uma pessoa pode fazer no Console e não são avaliadas no tráfego da Management API. Para controlar quem pode chamar este endpoint, controle quem pode ler à chave de API da aplicação.

Relacionados

Autorizações

x-api-key
string
header
obrigatório

Chave de API da sua aplicação, em Developers -> API keys no Business Console. A chave principal tem acesso total. Uma chave nomeada pode ter escopo restrito: nenhum acesso, leitura ou escrita por recurso, limitada a alguns fluxos ou a sessões aprovadas, a uma lista de endereços IP e a uma data de validade. 401 significa que a chave está errada, revogada ou expirada; 403 significa que nenhuma chave foi enviada, que a chave não tem acesso a este recurso ou ação, ou que a requisição veio de um endereço fora da sua lista de IPs; 404 em uma rota de sessão significa que a sessão está fora dos fluxos ou status da chave. Uma chave sem acesso a mídia recebe URLs de imagem, vídeo e PDF como null, e uma chave sem permissão de escrita em sessões recebe links e tokens de sessão como null. Consulte https://docs.didit.me/console/api-keys.

Parâmetros de consulta

limit
integer
padrão:50

Tamanho da página. O padrão é 50 quando omitido. Não há máximo imposto, mas mantenha as páginas pequenas para reduzir a latência.

Intervalo obrigatório: 1 <= x <= 1000000
offset
integer
padrão:0

Deslocamento, a partir de zero, do primeiro registro a retornar. Prefira seguir a URL next da página anterior em vez de calcular este valor manualmente.

Intervalo obrigatório: 0 <= x <= 1000000

Resposta

Lista paginada de usuários com status de verificação, contagem de sessões e detalhamento por recurso.

count
integer

Número de linhas correspondentes: exato até 100 e limitado a 100 acima disso, por desempenho. Não o use para detectar a última página; considere next igual a null.

next
string | null

URL absoluta da próxima página, ou null na última página.

previous
string | null

URL absoluta da página anterior, ou null na primeira página.

results
object[]
Última modificação em 1 de novembro de 2026