Saltar al contingut principal
GET
curl

Visió general

Retorna una llista paginada d’entitats empresarials de l’aplicació autenticada.

Quan utilitzar-lo

  • Sincronitza la taula d’empreses amb un BI extern o un magatzem de dades.
  • Cues d’analistes: filtra per status=FLAGGED per alimentar una safata de revisió.
  • Cerca per display_name, legal_name, registration_number o vendor_data.

Filtres i paginació

Notes

  • vendor_data pot ser null si la sessió o la transacció d’origen no n’han proporcionat cap.
  • Paginació basada en cursor: conserva el cursor next entre crides.
  • Consulta el model de dades d’empresa per a tots els camps.

Permisos

El rol ha de concedir list:businesses.

Relacionat

Autoritzacions

x-api-key
string
header
requerit

La clau d'API de la teva aplicació, des de Developers -> API keys a la Business Console. La clau primària té accés complet. Una clau amb nom pot tenir l'abast limitat: cap, lectura o escriptura per recurs, limitada a determinats fluxos de treball o a sessions aprovades, a una llista d'adreces IP i a una data de caducitat. 401 significa que la clau és incorrecta, revocada o caducada; 403 significa que no s'ha enviat cap clau, que la clau no té accés a aquest recurs o acció, o que la sol·licitud prové d'una adreça fora de la seva llista d'IP; 404 en una ruta de sessió significa que la sessió està fora dels fluxos de treball o estats de la clau. Una clau sense accés a fitxers multimèdia rep els URL d'imatge, vídeo i PDF com a null, i una clau sense permís d'escriptura de sessions rep els enllaços de sessió i els tokens com a null. Consulta https://docs.didit.me/console/api-keys.

Paràmetres de consulta

limit
integer
predeterminat:50

Mida de la pàgina. Per defecte és 50 si s'omet. No hi ha cap màxim imposat, però mantén les pàgines petites per reduir la latència.

Rang requerit: 1 <= x <= 1000000
offset
integer
predeterminat:0

Desplaçament basat en zero del primer registre a retornar. És preferible seguir l'URL next de la pàgina anterior abans que calcular-ho manualment.

Rang requerit: 0 <= x <= 1000000

Resposta

Llista paginada d'empreses amb estat, recomptes de sessions i desglossament de funcionalitats.

count
integer

Nombre de files coincidents: exacte fins a 100, limitat a 100 a partir d'aquí per motius de rendiment. No el facis servir per detectar la darrera pàgina; confia en canvi que next sigui null.

next
string | null

URL absoluta de la pàgina següent, o null a l'última pàgina.

previous
string | null

URL absoluta de la pàgina anterior, o null a la primera pàgina.

results
object[]
Darrera modificació el 7 de novembre del 2026