Перейти к основному содержанию
GET
curl

Обзор

Возвращает постраничный список сущностей компаний для авторизованного приложения.

Когда использовать

  • Синхронизируйте таблицу компаний с внешним BI или хранилищем данных.
  • Очереди для аналитиков: фильтруйте по status=FLAGGED, чтобы формировать очередь на проверку.
  • Поиск по display_name, legal_name, registration_number или vendor_data.

Фильтры и пагинация

Примечания

  • vendor_data может быть null, если исходная сессия или транзакция не передали его.
  • Пагинация на основе курсора: сохраняйте курсор next между вызовами.
  • Все поля описаны в модели данных компании.

Права доступа

Роль должна предоставлять list:businesses.

Связанные материалы

Авторизации

x-api-key
string
header
обязательно

API-ключ вашего приложения из раздела «Разработчикам» -> «API-ключи» в Business Console. Основной ключ имеет полный доступ. Именованный ключ может иметь ограниченную область действия: без доступа, чтение или запись для каждого ресурса, ограничение определенными сценариями или одобренными сессиями, списком IP-адресов и сроком действия. 401 означает, что ключ неверен, отозван или его срок действия истек; 403 означает, что ключ не был передан, у ключа нет доступа к этому ресурсу или действию, либо запрос поступил с адреса вне его списка IP-адресов; 404 на маршруте сессии означает, что сессия не входит в сценарии или статусы ключа. Ключ без доступа к медиа получает URL изображений, видео и PDF как null, а ключ без прав на запись сессий получает ссылки на сессии и токены как null. См. https://docs.didit.me/console/api-keys.

Параметры запроса

limit
integer
по умолчанию:50

Размер страницы. По умолчанию 50, если не указан. Жёсткого максимума нет, но рекомендуется оставлять страницы небольшими для уменьшения задержки.

Требуемый диапазон: 1 <= x <= 1000000
offset
integer
по умолчанию:0

Смещение первой возвращаемой записи, начиная с нуля. Рекомендуется переходить по URL next с предыдущей страницы вместо вычисления вручную.

Требуемый диапазон: 0 <= x <= 1000000

Ответ

Список компаний с пагинацией, со статусом, количеством сессий и детализацией по функциям.

count
integer

Количество подходящих строк: точное до 100, с ограничением в 100 сверх этого для производительности. Не используйте его для определения последней страницы; вместо этого ориентируйтесь на то, что next равен null.

next
string | null

Абсолютный URL следующей страницы или null на последней странице.

previous
string | null

Абсолютный URL предыдущей страницы или null на первой странице.

results
object[]
Последнее изменение 7 ноября 2026 г.