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

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

Запрос:

Параметр

Обязателен

Тип

Описание

userId

Да

Строка

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

limit

Да

Число

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

offset

Да

Число

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

Ответ:

Параметр

Тип

Описание

users

Массив

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

total

Число

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

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

Параметр

Тип

Описание

id

Строка

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

email

Строка

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

utm

Строка или null

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

createdAt

Строка

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

confirmedAt

Строка или null

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

lastLoginAt

Строка

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

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

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": "ed83d19f-30ef-4b3f-bca9-edd2c7714b16",
        "email": "[email protected]",
        "password": "sCPJUXnBrJ",
        "utm": null,
        "createdAt": "2025-06-09T13:18:11.462Z",
        "updatedAt": "2025-06-09T13:18:11.462Z",
        "confirmedAt": "2025-06-09T14:18:11.462Z",
        "lastLoginAt": null
      }
    ],
    "total": 1
  }
}

Last updated