CPcpanel
Team Users

List Team Users

Changed on

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.

get/Team/list_team

Request

  • Base URL
    https://cpanel-server.tld:2083/execute
  • Auth
    HTTP basic

Query parameters

formatstring
Example:array

The format in which the team data is listed.

Response

HTTP Request was successful.

apiversioninteger

The version of the API.

funcstring

The name of the method called.

modulestring

The name of the module called.

Example response

{
  "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"
      }
    ],
    "metadata": {
      "transformed": 1
    },
    "status": 1
  }
}

Changes

  • 05239220da37Revision changes
    • breaking

      added to the / response property oneOf list for the response status

    • info

      removed from the / response property oneOf list for the response status