When a user joins a monday.com account, they are assigned a role that specifies their permissions and what actions they can perform. All accounts have admin, member, viewer, and guest roles by default; some monday.com plans also allow you to create custom roles.

Queries

You can use the account_roles query to retrieve account role data via the API.

Required scope:account:read
Returns an object containing metadata about all user roles in an account (both default and custom)
Can only be queried directly at the root; can't be nested within another query

query {
  account_roles {
    id
    name
    roleType
  }
}

import { ApiClient } from "@mondaydotcomorg/api";
const mondayApiClient = new ApiClient({ token: myToken });

const query = `query { account_roles { id name roleType } }`;
const response = await mondayApiClient.request(query);

{
  "data": {
    "account_roles": [
      {
        "id": "1",
        "name": "admin",
        "roleType": "basic_role"
      },
      {
        "id": "2",
        "name": "member",
        "roleType": "basic_role"
      },
      {
        "id": "3",
        "name": "view_only",
        "roleType": "basic_role"
      },
      {
        "id": "4",
        "name": "guest",
        "roleType": "basic_role"
      }
    ]
  }
}

Fields

You can use the following fields to specify what information your account_roles query will return.

Fields	Description
id `ID`	The role's unique identifier.
name `String`	The role's name.
roleType `String`	The role's type.