Users

List portal users of the account

Returns the enabled portal users of the account: name, email, whether the user is the account's main user, roles (admin, reports, tech_config, finance, orders, support), and support departments.

get/users

Request

  • Base URL
    https://api.commpeak.com/portal
  • URL
    https://api.commpeak.com/portal/users
  • Auth
    API key in header Authorization

Response

Successful Response

Example response

{
  "users": [
    {
      "email": "test@example.com",
      "first_name": "John",
      "id": 7,
      "last_name": "Doe",
      "main_user": true,
      "roles": [
        "admin"
      ],
      "support_departments": []
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.