Saltar al contenido principal
GET
curl

Descripción general

Devuelve una lista paginada de entidades de usuario de la aplicación autenticada. Úsalo para sincronizar usuarios con tu data warehouse, encontrar usuarios que requieren la atención de un analista o buscar por nombre para mostrar.

Cuándo usarlo

  • Sincronización periódica de tu tabla de usuarios con herramientas externas de BI o con un data warehouse externo.
  • Colas de analistas: filtra por status=FLAGGED o por un last_activity_at desactualizado para alimentar una bandeja de revisión.
  • Buscar usuarios por display_name, full_name o vendor_data.

Filtros y paginación

Notas

  • Cada elemento de la respuesta incluye didit_internal_id. vendor_data puede ser null cuando la sesión o transacción original no lo proporcionó.
  • Este endpoint se pagina mediante cursor: guarda el cursor next entre llamadas y detente cuando next esté vacío.
  • Consulta el modelo de datos de usuario para ver todos los campos de una fila de usuario.

Permisos

Cualquier clave de API activa de la aplicación puede llamar a este endpoint. Las claves de API de Didit tienen alcance de aplicación, no de rol: los roles y permisos de la Console (list:users y los demás) determinan lo que una persona puede hacer en la Console y no se evalúan para el tráfico de la Management API. Controla quién puede llamar a este endpoint controlando quién puede leer la clave de API de la aplicación.

Relacionado

Autorizaciones

x-api-key
string
header
requerido

La clave de API de tu aplicación, que encontrarás en Developers -> API keys en la Business Console. La clave principal tiene acceso completo. Una clave con nombre puede tener un alcance limitado: ninguno, lectura o escritura por recurso, limitada a algunos flujos o a sesiones aprobadas, a una lista de direcciones IP y a una fecha de caducidad. 401 significa que la clave es incorrecta, se revocó o expiró; 403 significa que no se envió ninguna clave, que la clave no tiene acceso a este recurso o acción, o que la solicitud provino de una dirección fuera de su lista de IP; 404 en una ruta de sesión significa que la sesión está fuera de los flujos o estados de la clave. Una clave sin acceso a contenido multimedia recibe las URL de imágenes, videos y PDF como null, y una clave sin permiso de escritura en sesiones recibe los enlaces y tokens de sesión como null. Consulta https://docs.didit.me/console/api-keys.

Parámetros de consulta

limit
integer
predeterminado:50

Tamaño de página. Si se omite, el valor predeterminado es 50. No hay un máximo obligatorio, pero mantén las páginas pequeñas para reducir la latencia.

Rango requerido: 1 <= x <= 1000000
offset
integer
predeterminado:0

Desplazamiento, empezando en cero, del primer registro que se devuelve. Es preferible seguir la URL next de la página anterior en lugar de calcularlo a mano.

Rango requerido: 0 <= x <= 1000000

Respuesta

Lista paginada de usuarios con su estado de verificación, número de sesiones y desglose por función.

count
integer

Número de filas coincidentes: exacto hasta 100, limitado a 100 a partir de ahí por rendimiento. No lo uses para detectar la última página; comprueba en su lugar que next sea null.

next
string | null

URL absoluta de la página siguiente, o null en la última página.

previous
string | null

URL absoluta de la página anterior, o null en la primera página.

results
object[]
Última modificación el 1 de noviembre de 2026