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

Метод Get List of Users возвращает список всех пользователей.

GET /api/vendor/v1/users.json?api_token={api_token}

Аргументы

Название

Тип параметра

Тип данных

Обязательный/ 
Опциональный

Описание

api_tokenquerystringОбязательныйAPI токен Сотрудника, выполняющего операцию (см. Просмотр и обновление информации о Сотруднике в ActivePlatform. Руководство по Панели управления Оператора)

page

query

integer

Опциональный

Возвращается список пользователей по указанному номеру страницы

per_page

query

integer

Опциональный

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

sorting[field]

query

string

Опциональный

Сортировка списка по указанному полю

sorting[reversed]

query

string

Опциональный

Установка режима обратной сортировки по указанному полю:

  • true — список будет отсортирован по убыванию.
  • false — список будет отсортирован по возрастанию (используется по умолчанию).

filters[created_at]

query

date

Опциональный

Фильтрация списка по дате создания

filters[updated_at]

query

date

Опциональный

Фильтрация списка по дате обновления

filters[status]

query

string

Опциональный

Фильтрация списка по статусу

filters[email]

query

string

Опциональный

Фильтрация списка по email

Модель ответа

Название

Тип данных

Описание

id

integer

Уникальный идентификационный номер пользователя

first_name

string

Имя пользователя

middle_name

string

Отчество пользователя

last_name

string

Фамилия пользователя

email

string

Электронная почта пользователя, которая используется в качестве логина

status

string

Глобальный статус пользователя в ActivePlatform вне зависимости от статуса пользователя для конкретного клиента:

  • active — активный.
  • inactive — неактивный.

custom_attributes

array

Дополнительные параметры пользователя (см. Настройка дополнительных параметров в ActivePlatform. Руководство по Панели управления Оператора):

  • name — имя параметра.
  • value — значение параметра.

created_at

date

Дата и время создания пользователя

updated_at

date

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

Пример запроса

GET http://billing.activeplatform.com:80/api/vendor/v1/users?api_token=654321&sorting[reversed]=true

Пример ответа

[
  {
    "id": 2002984,
    "first_name": "Oleg",
    "middle_name": "",
    "last_name": "Ivanov",
    "email": "mario@activeplatform.com",
    "status": "active",
    "custom_attributes": [],
    "created_at": "2016-10-03T05:15:22.286+03:00",
    "updated_at": "2016-10-03T05:16:19.243+03:00"
  },
  {
    "id": 2002983,
    "first_name": "John",
    "middle_name": "J",
    "last_name": "Doe",
    "email": "john.doe@activeplatform.com",
    "status": "active",
    "custom_attributes": [],
    "created_at": "2016-08-15T08:15:22.549+03:00",
    "updated_at": "2016-08-15T08:15:22.549+03:00"
  }
]