Skip to content

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

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

Метод get.customer_users
Описание Получение списка пользователей клиентского личного кабинета из под которых можно совершать API запросы. Важно учитывать наличие прав доступа у пользователя.
Кому доступен Партнёр

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

Название Тип Обязательный Описание
access_token string да Ключ сессии аутентификации
limit number нет Количество возвращаемых записей. См. раздел "Постраничный вывод"
offset number нет Сдвиг, определяет с какого номера записи возвращать "limit" записей. По умолчанию "0". См. раздел "Постраничный вывод"
filter object нет См. раздел "Критерии фильтрации"
fields array нет См. раздел "Представление возвращаемых данных"
sort array нет См. раздел "Сортировка данных"

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

Название Тип Фильтрация Сортировка Описание
id number да Уникальный идентификатор пользователя
Используется как user_id во всех клиентских методах
login string Логин пользователя
description string Описание пользователя
name string да да Имя пользователя
customer_id number да да Уникальный идентификатор клиента

JSON структура запроса

{
  "jsonrpc":"2.0",
  "id":"number",
  "method":"get.customer_users",
  "params":{
    "access_token":"string",
    "offset":"number",
    "limit":"number",
    "filter":{

    },
    "sort":[
      {
        "field":"string",
        "order":"string"
      }
    ],
    "fields":[
      "string"
    ]
  }
}

JSON структура ответа

{
  "jsonrpc":"2.0",
  "id":"number",
  "result":{
    "metadata":{

    },
    "data":[
      {
        "id":"number",
        "name":"string",
        "description":"string",
        "login":"string",
        "customer_id":"number"
      }
    ]
  }
}

Список возвращаемых ошибок

Смотрим раздел "Список ошибок для методов с глаголом get"