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

Метод 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
        }
    }
}