Список участников команды

Метод TeamManagement.getList возвращает список всех пользователей в команде. Этот список содержит также владельца команды.
Вы также можете просмотреть список команды используя Serpstat интерфейс.

Общие параметры запроса и инструкция по использованию Serpstat API

Параметры запроса
Параметр	Описание	Тип данных	Обязательный	Значение по умолчанию	Варианты значений
id	Идентификатор запроса: ответ содержит этот же идентификатор.	int/string	да		Числовое или текстовое значение, например: 1, test
method	Название метода API	string	да		TeamManagement.getlist
params	Объект с параметрами {...}, в нем перечисляются все нижеследующие параметры и массивы [...]	array	да
search	Поисковая строка для сравнения с именем и email пользователя	int	нет		Числовое или текстовое значение, например: @
page	Номер страницы в ответе	int	нет	1	Числовое значение, например: 1
size	Количество результатов на страницу в ответе	int	нет	100	Числовое значение, например: 20

Параметры ответа
Параметр	Описание
id	Идентификатор запроса: соответствует id в запросе
result	Содержит в себе ответ
data	Массив со списком пользователей
user_id	ID пользователя
status	Статус участника команды. 0 - не подтвержден 1 - активный 2 - неактивный
email	email пользователя
first_name	Имя пользователя
last_name	Фамилия пользователя
limits	Содержит информацию о лимитах команды
total	Максимальный размер команды. (Может быть увеличен, для этого свяжитесь с нами)
used	Количество занятых мест в команде
left	Количество доступных мест в команде

Лимиты: этот метод не списывает лимитов.

Example

Request data:

{
    "id": "1",
    "method": "TeamManagement.getList",
    "params": {
        "search": "@",
        "page": 1,
        "size": 20
    }
}

Response data:

{
    "id": "1",
    "result": {
        "data": [
            {
                "user_id": 12345,
                "status": 1,
                "email": "owner@example.test",
                "first_name": "Team",
                "last_name": "Owner",
            },
            {
                "user_id": 12346,
                "status": 1,
                "email": "member@example.test",
                "first_name": "John",
                "last_name": "Doe",
            }
        ],
        "summary_info": {
            "total": 2,
            "page": 1
        },
        "limits": {
            "total": 7,
            "used": 2,
            "left": 5
        }
    }
}