Skip to main content
GET
curl

Overview

Returns a paginated list of Business entities for the authenticated application.

When to use it

  • Sync your business table to an external BI or warehouse.
  • Analyst queues — filter by status=FLAGGED to drive a review inbox.
  • Search by display_name, legal_name, registration_number, or vendor_data.

Filters and pagination

Notes

  • vendor_data may be null if the originating session or transaction did not provide one.
  • Cursor-based pagination — persist the next cursor between calls.
  • See the Business data model for every field.

Permissions

Role must grant list:businesses.

Authorizations

x-api-key
string
header
required

Your application's API key, from Developers -> API keys in the Business Console. The primary key has full access. A named key can be scoped: none, read or write per resource, limited to some workflows or to approved sessions, to a list of IP addresses, and to an expiry date. 401 means the key is missing, wrong, revoked or expired; 403 means the key has no access to this resource or action, or the request came from an address outside its IP list; 404 on a session route means the session is outside the key's workflows or statuses. A key without media access receives image, video and PDF URLs as null, and a key without sessions write receives session links and tokens as null. See https://docs.didit.me/console/api-keys.

Query Parameters

limit
integer
default:50

Page size. Defaults to 50 when omitted. There is no enforced maximum, but keep pages small for latency.

Required range: x >= 1
offset
integer
default:0

Zero-based offset of the first record to return. Prefer following the next URL from the previous page over computing this by hand.

Required range: x >= 0

Response

Paginated list of businesses with status, session counts, and feature breakdown.

count
integer

Number of matching rows — exact up to 100, capped at 100 beyond that for performance. Do not use it to detect the last page; rely on next being null instead.

next
string | null

Absolute URL of the next page, or null on the last page.

previous
string | null

Absolute URL of the previous page, or null on the first page.

results
object[]