Vai al contenuto principale
GET
curl

Panoramica

Restituisce un elenco paginato delle entità aziendali per l’applicazione autenticata.

Quando usarlo

  • Sincronizza la tabella delle aziende con un sistema BI esterno o un magazzino dati.
  • Code degli analisti: filtra con status=FLAGGED per alimentare una casella di revisione.
  • Cerca per display_name, legal_name, registration_number o vendor_data.

Filtri e paginazione

Note

  • vendor_data può essere null se la sessione o la transazione di origine non ne ha fornito uno.
  • Paginazione basata su cursore: salva il cursore next tra una chiamata e l’altra.
  • Consulta il modello dei dati aziendali per ogni campo.

Autorizzazioni

Il ruolo deve garantire l’autorizzazione list:businesses.

Correlati

Autorizzazioni

x-api-key
string
header
obbligatorio

La chiave API della tua applicazione, da Developers -> API keys nella Business Console. La chiave primaria ha accesso completo. Una chiave con nome può avere un ambito definito: nessuno, lettura o scrittura per risorsa, limitata ad alcuni workflow o a sessioni approvate, a un elenco di indirizzi IP e a una data di scadenza. 401 indica che la chiave è errata, revocata o scaduta; 403 indica che non è stata inviata alcuna chiave, che la chiave non ha accesso a questa risorsa o azione, oppure che la richiesta proviene da un indirizzo non incluso nel suo elenco IP; 404 su una route di sessione indica che la sessione non rientra nei workflow o negli stati previsti dalla chiave. Una chiave senza accesso ai media riceve gli URL di immagini, video e PDF come null, e una chiave senza permessi di scrittura sulle sessioni riceve link e token di sessione come null. Consulta https://docs.didit.me/console/api-keys.

Parametri della query

limit
integer
predefinito:50

Dimensione della pagina. Se omessa, il valore predefinito è 50. Non esiste un massimo imposto, ma mantieni le pagine piccole per ridurre la latenza.

Intervallo richiesto: 1 <= x <= 1000000
offset
integer
predefinito:0

Offset in base zero del primo record da restituire. È preferibile seguire l'URL next della pagina precedente invece di calcolarlo manualmente.

Intervallo richiesto: 0 <= x <= 1000000

Risposta

Elenco impaginato delle aziende con stato, conteggio delle sessioni e riepilogo delle funzionalità.

count
integer

Numero di righe corrispondenti: esatto fino a 100, con limite massimo di 100 oltre tale soglia per motivi di prestazioni. Non utilizzarlo per rilevare l'ultima pagina; fai invece affidamento sul fatto che next sia null.

next
string | null

URL assoluto della pagina successiva, o null sull'ultima pagina.

previous
string | null

URL assoluto della pagina precedente, o null sulla prima pagina.

results
object[]
Ultima modifica il 7 novembre 2026