Passer au contenu principal
GET
curl

Aperçu

Renvoie une liste paginée des entités d’entreprise pour l’application authentifiée.

Quand l’utiliser

  • Synchronisez votre table des entreprises avec un outil de BI externe ou un entrepôt de données.
  • Files d’attente des analystes : filtrez avec status=FLAGGED pour alimenter une boîte de réception pour examen.
  • Recherchez par display_name, legal_name, registration_number ou vendor_data.

Filtres et pagination

Remarques

  • vendor_data peut être null si la session ou la transaction d’origine n’en a pas fourni.
  • Pagination par curseur : conservez le curseur next entre les appels.
  • Consultez le modèle de données des entreprises pour connaître chaque champ.

Autorisations

Le rôle doit disposer de l’autorisation list:businesses.

Liens connexes

Autorisations

x-api-key
string
header
requis

La clé API de votre application, issue de Développeurs -> Clés API dans la Business Console. La clé principale dispose d'un accès complet. Une clé nommée peut être restreinte : aucun, lecture ou écriture par ressource, limitée à certains workflows ou aux sessions approuvées, à une liste d'adresses IP et à une date d'expiration. 401 signifie que la clé est incorrecte, révoquée ou expirée ; 403 signifie qu'aucune clé n'a été envoyée, que la clé n'a pas accès à cette ressource ou action, ou que la requête provient d'une adresse hors de sa liste d'IP ; 404 sur une route de session signifie que la session est hors des workflows ou des statuts de la clé. Une clé sans accès aux médias reçoit les URL d'images, de vidéos et de PDF à null, et une clé sans accès en écriture aux sessions reçoit les liens et tokens de session à null. Voir https://docs.didit.me/console/api-keys.

Paramètres de requête

limit
integer
défaut:50

Taille de page. Vaut 50 par défaut si omis. Aucun maximum n'est imposé, mais conservez des pages de petite taille pour limiter la latence.

Plage requise: 1 <= x <= 1000000
offset
integer
défaut:0

Décalage de départ (base zéro) du premier enregistrement à retourner. Privilégiez l'utilisation de l'URL next de la page précédente plutôt que de le calculer manuellement.

Plage requise: 0 <= x <= 1000000

Réponse

Liste paginée des entreprises avec statut, décompte des sessions et détail des fonctionnalités.

count
integer

Nombre de lignes correspondantes — exact jusqu'à 100, plafonné à 100 au-delà pour des raisons de performance. Ne l'utilisez pas pour détecter la dernière page ; fiez-vous plutôt au fait que next soit null.

next
string | null

URL absolue de la page suivante, ou null sur la dernière page.

previous
string | null

URL absolue de la page précédente, ou null sur la première page.

results
object[]
Dernière modification le 7 novembre 2026