Query
query Roles {
roles {
edges {
cursor
node {
id
name
description
permissions
isAssignableToCustomer
isAssignableToThread
}
}
pageInfo {
hasPreviousPage
hasNextPage
startCursor
endCursor
}
}
}Response
{
"data": {
"roles": {
"edges": [
{
"cursor": "string",
"node": {
"id": "id",
"name": "string",
"description": "string",
"permissions": [
"string"
],
"isAssignableToCustomer": true,
"isAssignableToThread": true
}
}
],
"pageInfo": {
"hasPreviousPage": true,
"hasNextPage": true,
"startCursor": "string",
"endCursor": "string"
}
}
}
}Queries
roles
Returns all roles available in the workspace, including both built-in roles (Owner, Admin, Support, Viewer, None) and any custom roles. Supports cursor-based pagination. Requires the roles:read permission.
QUERY
roles(first: Int, after: String, last: Int, before: String, filters: RoleFilter): RoleConnection!Arguments
first
Int
after
String
last
Int
before
String
filters
Returns
edges
[RoleEdge!]!
pageInfo
Query
query Roles {
roles {
edges {
cursor
node {
id
name
description
permissions
isAssignableToCustomer
isAssignableToThread
}
}
pageInfo {
hasPreviousPage
hasNextPage
startCursor
endCursor
}
}
}Response
{
"data": {
"roles": {
"edges": [
{
"cursor": "string",
"node": {
"id": "id",
"name": "string",
"description": "string",
"permissions": [
"string"
],
"isAssignableToCustomer": true,
"isAssignableToThread": true
}
}
],
"pageInfo": {
"hasPreviousPage": true,
"hasNextPage": true,
"startCursor": "string",
"endCursor": "string"
}
}
}
}Was this page helpful?

