Users
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.
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 | A list of users' unique identifiers. |
kind | The kind to search users by (all / non_guests / guests / non_pending). |
newest_first | Get the recently created users at the top of the list. |
limit | 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 | The user's account. |
birthday | The user's date of birth, as set in their profile and returned as YYYY-MM-DD. |
country_code | The user's country code. |
created_at | When the user profile was created, returned as YYYY-MM-DD. |
join_date | The date the user joined the account and returned as YYYY-MM-DD. |
email | The user's email. |
enabled | Will return |
encrypt_api_token | This is the user's access token. It can be used for building the board's email address. |
id | The user's unique identifier. |
is_admin | Will return true if the user is an Admin; |
is_guest | Will return |
is_pending | Will return |
is_view_only | Will return |
is_verified | Will return "true" if the user confirmed their profile via the confirmation email. |
location | The user's location. |
mobile_phone | The user's mobile phone number. |
name | The user's name. |
phone | The user's phone number. |
photo_original | Will return the URL of the user's uploaded photo in its original size. |
photo_small | Will return the URL of the user's uploaded photo in a small size (150x150 px). |
photo_thumb | Will return the URL of the user's uploaded photo in thumbnail size (100x100 px). |
photo_thumb_small | Will return the URL of the user's uploaded photo a small thumbnail size (50x50 px |
photo_tiny | Will return the URL of the user's uploaded photo in tiny size (30x30). |
teams | The teams the user is a member in. Also includes the following argument: ids |
time_zone_identifier | The user's timezone identifier. |
title | The user's title. |
url | The user's profile URL. |
utc_hours_diff | The user’s UTC hours difference. |
Updated 3 months ago