List of team users

The TeamManagement.getList method returns list of all users in your team. This list includes team owner as well. You also can see the list of users using Serpstat interface.

General request parameters and instructions for using Serpstat API

Request parameters
Parameter	Description	Type	Required	Default value	Value Options
id	A request id: the response contains the same id.	int/string	yes		Any text or number value, for example: 1, test
method	API method name	string	yes		TeamManagement.getlist
params	The object with parameters {...}, it lists all the following parameters and arrays [...]	array	yes
search	Search string to be compared with user's name and email	int	no		Text or number value, for example: @
page	Page number in response	int	no	1	Number value, for example: 1
size	Number of results per page in response	int	no	100	Number value, for example: 20

Response parameters
Parameter	Description
id	Response id: corresponds the request id
result	Contains the answer
data	Array with list of users
user_id	ID of the user
status	Team membership status. 0 - not confirmed 1 - active 2 - inactive
email	User's email
first_name	User's first name
last_name	User's last name
limits	Contains information about team limits
total	Maximum team size. (Can be increased, contact us)
used	Already used team seats
left	Available team seats

Credits: this method does not charge credits.

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
        }
    }
}