Skip to main content
objectRole

Fields

id
ID!
name
String!
description
String
permissions
[String!]!

The list of permission strings granted to users who hold this role.

isAssignableToCustomer
Boolean!
deprecated
Use isAssignableToThread instead
isAssignableToThread
Boolean!

Whether this role can be used when assigning a user to a thread.

isAssignableToTask
Boolean!

Whether this role can be used when assigning a user to a task.

assignableBillingSeats
deprecated
Don't use. Will be removed soon.
requiresBillableSeat
Boolean!
deprecated
Don't use. Will be removed soon.

The stable enum key for built-in roles (e.g. OWNER, SUPPORT). For a custom role, the key of the built-in role it is based on.

customRoleId
ID

If this role is a custom role, this field contains the custom role ID.

customRole
priority
Int!

Decides which role wins when a user is given more than one through SSO or directory sync. Higher wins. Built-in roles are fixed at 5000 (owner), 4000 (admin), 3000 (support), 2000 (viewer) and 1000 (none).