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

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

Запрос:

Параметр	Обязателен	Тип	Описание
userId	Да	Строка	Идентификатор пользователя
limit	Да	Число	Лимит на количество пользователей в ответе
offset	Да	Число	Сдвиг (для пагинации)

Ответ:

Параметр	Тип	Описание
users	Массив	Массив объектов пользователя
total	Число	Общее количество пользователей

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

Параметр	Тип	Описание
id	Строка	Идентификатор пользователя
email	Строка	Email пользователя
utm	Строка или null	Данные о utm-метке (если пользователь зарегистрировался через веб интерфейс)
createdAt	Строка	Дата регистрации пользователя
confirmedAt	Строка или null	Дата подтверждения почты пользователя
lastLoginAt	Строка	Дата последнего входа пользователя через веб интерфейс

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

POSThttps://app.apollopayment.io/partner/api/get-users

Header parameters

Body

application/json

limitinteger

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

offsetinteger

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

Response

200

Body

application/json

success*boolean

Признак успешности запроса

response*GetPartnerUsersResponse (object)

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

Request

JavaScriptCurlPython

const response = await fetch('https://app.apollopayment.io/partner/api/get-users', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "success": false,
  "response": {
    "users": [
      {
        "id": "22c0e65e-4640-4b5b-9a28-518c88a421e4",
        "email": "[e-mail]",
        "password": "sCPJUXnBrJ",
        "utm": null,
        "createdAt": "2024-11-07T12:42:22.490Z",
        "updatedAt": "2024-11-07T12:42:22.491Z",
        "confirmedAt": "2024-11-07T13:42:22.491Z",
        "lastLoginAt": null
      }
    ]
  }
}