List Team Users

This function lists the team users connected to a cPanel account. This list is given in an array by default, but can be given in a hash.

SecurityBasicAuth

Request

query Parameters

format

string

The format in which the team data is listed.

Example: format=array

Responses

200

HTTP Request was successful.

Response Schema: application/json

apiversion	integer The version of the API.
func	string The name of the method called.
module	string The name of the module called.
	object

get/Team/list_team

Request samples

CLI
URL
LiveAPI Perl
LiveAPI PHP

uapi --output=jsonpretty \
  --user=username \
  Team \
  list_team

Response samples

application/json

{"apiversion": 3,
"func": "list_team",
"module": "Team",
"result": {"data": [{"contact-email": "team_user@example.com",
"created": 1650036110,
"expire_date": 1674575562,
"expire_reason": "team user 1 year",
"lastlogin": 1650046110,
"locale": "en",
"notes": "This is a note about team user.",
"password": "encryptedpassword",
"roles": ["email,web"
],
"secondary-contact-email": "team_user_backup@example.com",
"services": {"email": "500*2**20",
"ftp": 1,
"webdisk": "rw"
},
"suspend_date": 1650046210,
"suspend_reason": "team user is on vacation",
"username": "teamuser"
}
],
"errors": null,
"messages": null,
"metadata": {"transformed": 1
},
"status": 1,
"warnings": null
}
}