Required scope: users:read

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

You can place users at the root of your query or nest them within another query. Querying users returns one or multiple users.

To learn more about users, check out our resource here.

query {
    users (ids: [3332456, 8375782, 9304582]) {
        created_at
        email
        account {
            name
            id
        }
    }
}
let query = "query { users (ids: [3332456, 8375782, 9304582]) { 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)));
curl --location --request POST 'https://api.monday.com/v2' \
--header 'Authorization: YourSuperSecretAPIkey' \
--header 'Content-Type: application/json' \
--data-raw '{"query": "query { users (ids: [3332456, 8375782, 9304582]) { created_at email account { name id}}"}'
}}'

Arguments

The following users() arguments can reduce the number of users returned.

Argument

Description

ids [Int]

A list of users' unique identifiers.

kind UserKind

The kind to search users by (all / non_guests / guests / non_pending).

newest_first Boolean

Get the recently created users at the top of the list.

limit Int

Number of users to get.

Fields

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

Field

Field Description

account !Account

The user's account.

birthday Date

The user's date of birth, as set in their profile and returned as YYYY-MM-DD.

country_code String

The user's country code.

created_at Date

When the user profile was created, returned as YYYY-MM-DD.

join_date Date

The date the user joined the account and returned as YYYY-MM-DD.

email !String

The user's email.

enabled !Boolean

Will return true if the user is enabled.

encrypt_api_token String

This is the user's access token. It can be used for building the board's email address.

id !Int

The user's unique identifier.

is_admin Boolean

Will return true if the user is an Admin;

is_guest Boolean

Will return true if the user is a guest.

is_pending Boolean

Will return true if the user didn't confirm their email yet.

is_view_only Boolean

Will return true if the user is a Viewer.

is_verified Boolean

Will return "true" if the user confirmed their profile via the confirmation email.

location String

The user's location.

mobile_phone String

The user's mobile phone number.

name !String

The user's name.

phone String

The user's phone number.

photo_original String

Will return the URL of the user's uploaded photo in its original size.

photo_small String

Will return the URL of the user's uploaded photo in a small size (150x150 px).

photo_thumb String

Will return the URL of the user's uploaded photo in thumbnail size (100x100 px).

photo_thumb_small String).

Will return the URL of the user's uploaded photo a small thumbnail size (50x50 px

photo_tiny String

Will return the URL of the user's uploaded photo in tiny size (30x30).

teams [Team]

The teams the user is a member in. Also includes the following argument:

ids [Int]
A list of the teams' identifiers to reference.

time_zone_identifier String

The user's timezone identifier.

title String

The user's title.

url !String

The user's profile URL.

utc_hours_diff Int

The user’s UTC hours difference.

current_language String

The user's language.

📘

Do you 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!


Did this page help you?