Saltar al contenido principal
GET
curl

Descripción general

Devuelve una lista paginada de entidades comerciales de la aplicación autenticada.

Cuándo usarlo

  • Sincroniza tu tabla de empresas con una herramienta de BI o un data warehouse externo.
  • Colas de analistas: filtra por status=FLAGGED para alimentar una bandeja de revisión.
  • Buscar por display_name, legal_name, registration_number o vendor_data.

Filtros y paginación

Notas

  • vendor_data puede ser null si la sesión o la transacción de origen no lo proporcionaron.
  • La paginación se basa en cursores: guarda el cursor next entre llamadas.
  • Consulta el modelo de datos de empresa para ver todos los campos.

Permisos

El rol debe otorgar list:businesses.

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 empresas con su estado, 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