Every monday.com user is a part of an account (i.e an organization) and could be a member or a guest in that account.

Users queries

Required scope: users:read

Querying users returns one or multiple users. You can place users at the root of your query or nest it within another query. Please note that nesting users in another query will increase its complexity.

query {
    users (ids: 123456789) {
    name
    email
    url
    }
}

let query = "query { users (ids: 123456789) { name email url }";

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)));

You can find the Postman request to get user data here.

Arguments

The following arguments can reduce the number of users returned.

Fields

Fields are used to return specific properties in an object. The following fields will determine what information is returned from your users query.

Users mutations

Add users to a board

Required scope: boards:write

This method allows you to add users to a board. You can define if the users will be added as regular subscribers or as owners of the board.

mutation {
    add_users_to_board (board_id: 123456789, user_ids: [123456, 234567, 345678], kind: owner) {
        id
    }
}

Arguments for add users to a board

The following arguments define the users added to the board.

Add users to a workspace

Required scope: workspaces:write

This mutation allows you to add users to a workspace. You can define if users will be added as regular subscribers or as owners of the workspace.

mutation {
    add_users_to_workspace (workspace_id: 12345678, user_ids: [123456, 654321, 012345], kind: subscriber) {
        id
    }
}

fetch ("https://api.monday.com/v2", {
  method: 'post',
  headers: {
    'Content-Type': 'application/json',
    'Authorization' : 'YourSuperSecretAPIkey'
   },
   body: JSON.stringify({
     query : "mutation { add_users_to_workspace (workspace_id: 12345678, user_ids: [123456, 654321, 012345], kind: subscriber) { id } }"
   })
  })

Arguments for add users to a workspace

The following arguments define which users to add to the workspace and their subscription type.

Delete users from a workspace

Required scope: workspaces:write

Allows you to delete users from a workspace.

mutation {
    delete_users_from_workspace (workspace_id: 12345678, user_ids: [123456, 654321, 012345]) {
        id
    }
}

fetch ("https://api.monday.com/v2", {
  method: 'post',
  headers: {
    'Content-Type': 'application/json',
    'Authorization' : 'YourSuperSecretAPIkey'
   },
   body: JSON.stringify({
     query : "mutation { delete_users_from_workspace (workspace_id: 12345678, user_ids: [123456, 654321, 012345]) { id } }"
   })
  })

Arguments for delete users from a workspace

The following arguments define which users to remove from the workspace.

📘

Have questions?

Join our developer community! You can share your questions and learn from fellow users and monday.com product experts.

Don’t forget to search before opening a new topic!