API Documentation
Русский
Русский
  • Авторизация
  • Подпись запросов
  • Список кодов ошибок
  • Webhooks
  • IFrame ордер
  • Виджет приема оплаты
  • Telegram MiniApp
  • API Reference
    • Базовый функционал
      • Проверка корректности подписи x-api-signature
      • Получение монет доступных для приема/отправки транзакций
      • Запрос текущей цены
      • Поиск операции по TX-хешу
      • Проверка корректности адреса
      • Получение истории транзакций
    • Авансовый счет
      • Получение аккаунтов текущего пользователя
      • Получение аккаунта по его ID
      • Получение адреса для пополнения баланса аккаунта
    • Блокчейн-адреса
      • Поиск по ID
      • Отслеживание транзакций
      • Поиск по адресу
      • Мета-данные
      • Транзакции адреса
      • Последняя транзакция адреса
      • Получение списка PayIn адресов
      • Получение списка бизнес адресов
      • Получение рекуррентных адресов
      • Получение списка PayOut адресов
      • Создание нового адрес бизнес кошелька
      • Создание нового адрес PayOut кошелька
    • Персональные адреса
      • Создание пользователя
      • Получение адреса
      • Получение списка адресов
      • Получение пользователя
      • Добавление доверенного адреса
      • Получение списка доверенных адресов
      • Удаление доверенного адреса
    • Ордера
      • Создание ордера
      • Получение информации об ордере
      • Получение списка ордеров
    • Выводы
      • Получение комиссии для проведения вывода
      • Синхронный вывод
      • Асинхронный вывод
      • Получение информации о выводе
    • Счета
      • Создание счета на оплату
      • Запрос получения информации об инвойсе
      • Получение списка счетов
    • Авто обмены
      • Создание авто-обмена
      • Поиск авто-обмена по ID
    • Выплаты 2.0
      • Создание авто-вывода
      • Поиск авто-вывода по ID
      • Дополнительное подтверждение вывода
    • Мост
      • Получение лимиов для кроссчейн перевода
      • Получение информации о кроссчейн переводе
      • Формирование токена комисси
      • Создание кроссчейн перевода
    • Обмены
      • Получение лимитов для кроссчейн обмена
      • Получение информации о кроссчейн обмене
      • Формирование токена комисси
      • Создание кроссчейн обмена
    • Рекуррентные платежи
      • Создание платежной связки
      • Получение платежной связки
      • Получение платежных связок по пользователю
      • Отключение платежной связки
      • Создание подписки
      • Получение подписки
      • Отключение подписки
      • Создание платежа
    • KYT
      • Проверка рисков транзакции
      • Проверка рисков вывода
      • Проверка риска вывода на указанный адрес
    • Партнерское API
      • Создание пользователя
      • Получение пользователя
      • Получение всех пользователей
      • Создание организации
      • Получение списка организаций
      • Получение авансовых балансов пользователя
      • Пополнение авансового баланса пользователя
      • Получение общих тарифов
      • Создание/обновление индивидуального тарифа
      • Получение индвидуальных тарифов
      • Создание API ключа
      • Получение API ключей
      • Удаление API ключа
    • Вебхуки
      • Получение вебхука
      • Получение вебхука (расширенный)
    • Сиротские транзакции
      • Получение транзакции
      • Получение списка транзакций
      • Получение токена комиссии
      • Вывод
    • Адресная книга
      • Добавление адреса
      • Удаление адреса
      • Обновление адреса
      • Получение списка адресов
Powered by GitBook
On this page
  1. API Reference
  2. Партнерское API

Получение всех пользователей

Метод позволяет получить всех пользователей

Запрос:

Параметр

Обязателен

Тип

Описание

userId

Да

Строка

Идентификатор пользователя

limit

Да

Число

Лимит на количество пользователей в ответе

offset

Да

Число

Сдвиг (для пагинации)

Ответ:

Параметр

Тип

Описание

users

Массив

Массив объектов пользователя

total

Число

Общее количество пользователей

Объект пользователя:

Параметр

Тип

Описание

id

Строка

Идентификатор пользователя

email

Строка

Email пользователя

utm

Строка или null

Данные о utm-метке (если пользователь зарегистрировался через веб интерфейс)

createdAt

Строка

Дата регистрации пользователя

confirmedAt

Строка или null

Дата подтверждения почты пользователя

lastLoginAt

Строка

Дата последнего входа пользователя через веб интерфейс

PreviousПолучение пользователяNextСоздание организации

Last updated 8 months ago

  • Запрос:
  • Ответ:
  • POSTПолучение всех пользователей

Получение всех пользователей

post
Header parameters
x-api-public-keystringOptional

Публичный API-ключ

x-api-signaturestringOptional

Подпись тела запроса приватным API-ключем

Content-typestringOptional

Тип тела запроса

Example: application/json
Body

Тело запроса получения списка пользователей

limitintegerOptional

Количество элементов на странице

offsetintegerOptional

Количество элементов для пропуска

Responses
200Success
application/json
post
POST /partner/api/get-users HTTP/1.1
Host: ocp.onchainpay.io
Content-Type: application/json
Accept: */*
Content-Length: 22

{
  "limit": 1,
  "offset": 1
}
200Success
{
  "success": true,
  "response": {
    "users": [
      {
        "id": "7376bfd8-2e53-4832-8445-50095093b5c2",
        "email": "my-client@example.com",
        "password": "sCPJUXnBrJ",
        "utm": null,
        "createdAt": "2024-12-26T08:21:33.122Z",
        "updatedAt": "2024-12-26T08:21:33.123Z",
        "confirmedAt": "2024-12-26T09:21:33.123Z",
        "lastLoginAt": null
      }
    ],
    "total": 1
  }
}