Learn how to use API tokens to read user data through the platform API
All monday.com users have a unique set of user details and different roles within an account. These details are available to access via the API by querying the me
object.
Queries
Required scope: me:read
- Returns an object containing metadata about the user whose API key is being used
- Can only be queried directly at the root
query {
me {
is_guest
created_at
name
id
}
}
let query = "query { me { is_guest created_at 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)));
Fields
You can use the following field(s) to specify what information your me
query will return.
Fields | Description |
---|---|
account Account! | The user's account. |
birthday Date | The user's date of birth that's set in their profile. Returned as YYYY-MM-DD. |
country_code String | The user's country code. |
created_at Date | The user's creation date. Returned as YYYY-MM-DD. |
current_language String | The user's language. |
join_date Date | The date the user joined the organization. Returned as YYYY-MM-DD. |
email String! | The user's email. |
enabled Boolean! | Returns true if the user is enabled. |
id ID! | The user's unique identifier. |
is_admin Boolean | Returns true if the user is an admin. |
is_guest Boolean | Returns true if the user is a guest. |
is_pending Boolean | Returns true if the user didn't confirm their email yet. |
is_verified Boolean | Returns true if the user verified their email. |
is_view_only Boolean | Returns true if the user is only a viewer. |
last_activity Date | The last date and time the user was active. |
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 | Returns the URL of the user's uploaded photo in its original size. |
photo_small String | Returns the URL of the user's uploaded photo in a small size (150x150 px). |
photo_thumb String | Returns the URL of the user's uploaded photo in thumbnail size (100x100 px). |
photo_thumb_small String | Returns the URL of the user's uploaded photo in a small thumbnail size (50x50 px). |
photo_tiny String | Returns the URL of the user's uploaded photo in tiny size (30x30 px). |
sign_up_product_kind String | The product the user first signed up to. |
teams [Team] | The user's teams. |
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. |
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! 😎