Learn how to query monday.com accounts using the platform API
All monday.com users must either join an existing account or create a new one. On the account level, users can do many things, including inviting other users to join the account, specifying their primary use of the platform, or signing up for a plan.
Queries
Required scope: account:read
- Returns an object containing metadata about a specific account
- Can be queried directly at the root or nested within a
me
orusers
query
query {
users {
account {
id
show_timeline_weekends
tier
slug
plan {
period
}
}
}
}
let query = "query { users { account { id show_timeline_weekends tier slug plan { period }}}}";
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 account
query will return. Some fields will have their own fields.
Fields | Description | Enum values | Supported fields |
---|---|---|---|
active_members_count Int | The number of active users in the account - includes active users across all products who are not guests or viewers. | ||
country_code String | The account's two-letter country code in ISO3166 format. Please note: the result is based on the location of the first account admin. | ||
first_day_of_the_week FirstDayOfTheWeek! | The first day of the week for the account. | monday sunday | |
id ID! | The account's unique identifier. | ||
logo String | The account's logo. | ||
name String! | The account's name. | ||
plan Plan | The account's payment plan. Returns null for accounts with the multi-product infrastructure. | max_users Int! period String tier String version Int! | |
products [AccountProduct] | The account's active products. | id Int kind AccountProductKind | |
show_timeline_weekends Boolean! | Shows true if weekends appear in the timeline. | ||
sign_up_product_kind String | The product the account first signed up to. | ||
slug String! | The account's slug. | ||
tier String | The account's tier. For accounts with multiple products, this will return the highest tier across all products. |