Roles

Roles allow you to assign a limited set of permissions to users in your account.

The role object

• id integer

  The system-generated ID of the role.

• name string

  The name of the role.

• description string

  A description about the role.

• permissions array

  The list of permissions associated to the role.

The role object

{
  "id": 1,
  "name": "Account owner",
  "description": "Has full access to the account.",
  "permissions": [
    "users.create",
    ...
  ]
}

List all roles

Sample request

curl https://www.yourdomain.com/api/v1/roles \
  -H "Accept: application/json" \
  -H "Authorization: Bearer <access-token>" \
  -G

Sample successful response

{
  "data": [
    {
        "id": 1,
        "name": "Account owner",
        "description": "Has full access to the account.",
        "permissions": [
          "users.create",
          ...
        ]
    },
    {...}
  ]
}