Saltar para o conteúdo principal
GET
curl

Visão geral

Devolve uma lista paginada de entidades de utilizador da aplicação autenticada. Use-a para sincronizar utilizadores com o seu armazém de dados, encontrar utilizadores que precisam da atenção de um analista ou pesquisar pelo nome a apresentar.

Quando utilizar

  • Sincronização periódica da sua tabela de utilizadores com uma ferramenta de BI ou armazém de dados externo.
  • Filas de analistas: filtre por status=FLAGGED ou por last_activity_at desatualizado para alimentar uma caixa de revisão.
  • Pesquisar utilizadores por display_name, full_name ou vendor_data.

Filtros e paginação

Notas

  • Cada item da resposta inclui didit_internal_id. vendor_data pode ser null quando a sessão ou transação original não o forneceu.
  • Este endpoint pagina através de cursor. Guarde o cursor next entre chamadas e pare quando next estiver vazio.
  • Consulte o modelo de dados do utilizador para ver todos os campos de um registo de utilizador.

Permissões

Qualquer chave de API ativa da aplicação pode chamar este endpoint. As chaves de API da Didit têm âmbito de aplicação, não de função: as funções e permissões da Consola (list:users e as restantes) determinam o que uma pessoa pode fazer na Consola e não são avaliadas para o tráfego da Management API. Controle quem pode chamar este endpoint controlando quem pode ler a chave de API da aplicação.

Relacionados

Autorizações

x-api-key
string
header
obrigatório

A chave de API da sua aplicação, a partir de Programadores -> Chaves de API na Business Console. A chave principal tem acesso total. Uma chave nomeada pode ter o âmbito definido: nenhum, 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á incorreta, 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 o pedido veio de um endereço fora da sua lista de IP; 404 numa rota de sessão significa que a sessão está fora dos fluxos ou estados da chave. Uma chave sem acesso a multimédia recebe URLs de imagens, vídeos e PDFs como nulos, e uma chave sem permissão de escrita em sessões recebe ligações de sessão e tokens como nulos. Consulte https://docs.didit.me/console/api-keys.

Parâmetros de consulta

limit
integer
padrão:50

Tamanho da página. A predefinição é 50 quando omitido. Não existe um limite máximo imposto, mas mantenha as páginas pequenas para reduzir a latência.

Intervalo necessário: 1 <= x <= 1000000
offset
integer
padrão:0

Offset de base zero do primeiro registo a devolver. Prefira seguir o URL next da página anterior em vez de calcular este valor manualmente.

Intervalo necessário: 0 <= x <= 1000000

Resposta

Lista paginada de utilizadores com estado de verificação, contagem de sessões e detalhe de funcionalidades.

count
integer

Número de linhas correspondentes — exato até 100, limitado a 100 acima disso por motivos de desempenho. Não o utilize para detetar a última página; em vez disso, confie no facto de next ser null.

next
string | null

URL absoluto da página seguinte, ou null na última página.

previous
string | null

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

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