Every monday.com user is part of an account or organization and has a unique set of user details. Users also have different roles within an account and can be admins, team members, members, viewers, guests, subscribers, board owners, or in a custom role. This information is accessible via the API through the users object.

As a developer working with monday.com, it is important to familiarize yourself with the users API so you know how to access user data. This document will walk you through the available queries and mutations to read and modify the users object via the API.

Queries

Required scope: users:read

Querying users will return metadata about one or multiple users. This method accepts various arguments and returns an array.

You can query users directly at the root or nest it within a teams query to return users from a specific team. Please note that nesting users in a teams query will increase its complexity.

Check out this query in action in our Postman library or follow along with these code samples!

query {
    users (limit: 50) {
    created_at
    email
    account {
      name
      id
    }
    }
}
let query = "query { users (limit: 50) { created_at email account { name id }}}";

fetch ("https://api.monday.com/v2", {
  method: 'post',
  headers: {
    'Content-Type': 'application/json',
    'Authorization' : 'YOUR_API_KEY_HERE'
   },
   body: JSON.stringify({
     query : query
   })
  })
   .then(res => res.json())
   .then(res => console.log(JSON.stringify(res, null, 2)));

Arguments

You can use the following argument(s) to reduce the number of results returned in your users query.

ArgumentDescription
emails [String]The specific user emails to return.
ids [Int]The specific users to return.
kind UserKindThe kind of users you want to search by: all, non_guests, guests, or non_pending.
limit IntThe number of users to get.
name StringA fuzzy search of users by name.
newest_first BooleanLists the most recently created users at the top.
non_active BooleanReturns the account's non-active users.
page IntThe page number to return. Starts at 1.

Fields

You can use the following field(s) to specify what information your users query will return. Please note that some fields will have their own arguments or fields.

FieldField descriptionSupported argumentsSupported fields
account Account!The user's account.
birthday DateThe user's date of birth. Returned as YYYY-MM-DD.
country_code StringThe user's country code.
created_at DateThe user's creation date. Returned as YYYY-MM-DD.
current_language StringThe user's language.
email String!The user's email.
enabled Boolean!Returns true if the user is enabled.
id Int!The user's unique identifier.
is_admin BooleanReturns true if the user is an admin.
is_guest BooleanReturns true if the user is a guest.
is_pending BooleanReturns true if the user didn't confirm their email yet.
is_view_only BooleanReturns true if the user is only a viewer.
is_verified BooleanReturns true if the user verified their email.
join_date DateThe date the user joined the account. Returned as YYYY-MM-DD.
last_activity DateThe last date and time the user was active. Returned as YYYY-MM-DDT00:00:00.
location StringThe user's location.
mobile_phone StringThe user's mobile phone number.
name String!The user's name.
out_of_office OutOfOfficeThe user's out-of-office status.active Boolean
disable_notifications Boolean
end_date Date
start_date Date
type String
phone StringThe user's phone number.
photo_original StringReturns the URL of the user's uploaded photo in its original size.
photo_small StringReturns the URL of the user's uploaded photo in a small size (150x150 px).
photo_thumb StringReturns the URL of the user's uploaded photo in thumbnail size (100x100 px).
photo_thumb_small StringReturns the URL of the user's uploaded photo in a small thumbnail size (50x50 px).
photo_tiny StringReturns the URL of the user's uploaded photo in tiny size (30x30 px).
sign_up_product_kind StringThe product the user first signed up to.
teams [Team]The user's teams.ids [Int]
time_zone_identifier StringThe user's timezone identifier.
title StringThe user's title.
url String!The user's profile URL.
utc_hours_diff IntThe userโ€™s UTC hours difference.

Mutations

Add users to a board

Required scope: boards:write

The add_users_to_board mutation allows you to add users to a board via the API. You can also specify what fields to query back from the user when you run the mutation.

mutation {
    add_users_to_board (board_id: 1234567890, user_ids: [123456, 234567, 345678], kind: owner) {
        id
    }
}
let query = "mutation { add_users_to_board (board_id:1234567890, user_ids: [123456, 234567, 345678], kind: owner) { id }}";

fetch ("https://api.monday.com/v2", {
  method: 'post',
  headers: {
    'Content-Type': 'application/json',
    'Authorization' : 'YOUR_API_KEY_HERE'
   },
   body: JSON.stringify({
     query : query
   })
  })
   .then(res => res.json())
   .then(res => console.log(JSON.stringify(res, null, 2)));

Arguments

You can use the following argument(s) to specify which users to add to the board and their roles.

ArgumentDescription
board_id Int!The board's unique identifier.
kind BoardSubscriberKindThe user's role: subscriber or owner.
user_ids [Int]!The unique identifiers of the users to add to the board.

Add users to a workspace

Required scope: workspaces:write

The add_users_to_workspace mutation allows you to add users to a workspace via the API. You can also specify what fields to query back from the user when you run the mutation.

mutation {
    add_users_to_workspace (workspace_id: 1234567, user_ids: [123456, 654321, 012345], kind: subscriber) {
        id
    }
}
let query = "mutation { add_users_to_workspace (workspace_id: 1234567, user_ids: [123456, 654321, 012345], kind: subscriber) { id } }";

fetch ("https://api.monday.com/v2", {
  method: 'post',
  headers: {
    'Content-Type': 'application/json',
    'Authorization' : 'YOUR_API_KEY_HERE'
   },
   body: JSON.stringify({
     query : query
   })
  })
   .then(res => res.json())
   .then(res => console.log(JSON.stringify(res, null, 2)));

Arguments

You can use the following argument(s) to specify which users to add to the workspace and their roles.

ArgumentsDescription
kind WorkspaceSubscriberKindThe user's role: subscriber or owner.
user_ids [Int]!The unique identifiers of the users to add to the workspace.
workspace_id Int!The workspace's unique identifier.

Delete users from a workspace

Required scope: workspaces:write

The delete_users_from_workspace mutation allows you to delete users from a workspace via the API. You can also specify what fields to query back from the user when you run the mutation.

mutation {
    delete_users_from_workspace (workspace_id: 1234567, user_ids: [123456, 654321, 012345]) {
        id
    }
}
let query = "mutation { delete_users_from_workspace (workspace_id: 1234567, user_ids: [123456, 654321, 012345]) { id } }";

fetch ("https://api.monday.com/v2", {
  method: 'post',
  headers: {
    'Content-Type': 'application/json',
    'Authorization' : 'YOUR_API_KEY_HERE'
   },
   body: JSON.stringify({
     query : query
   })
  })
   .then(res => res.json())
   .then(res => console.log(JSON.stringify(res, null, 2)));

Arguments

You can use the following argument(s) to specify which users to delete from the workspace.

ArgumentsDescription
user_ids [Int]!The unique identifiers of the users to remove from the workspace.
workspace_id Int!The workspace's unique identifier.

๐Ÿ“˜

Join our developer community!

We've created a community specifically for our devs where you can search through previous topics to find solutions, ask new questions, hear about new features and updates, and learn tips and tricks from other devs. Come join in on the fun! ๐Ÿ˜Ž