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. At the account level, users can invite other users to join the account, specify their primary platform use, sign up for a plan, and more!
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
meorusersquery
Get account
query {
users {
account {
id
slug
tier
show_timeline_weekends
is_during_trial
plan {
period
}
product {
kind
id
tier
}
}
}
}import { ApiClient } from "@mondaydotcomorg/api";
const mondayApiClient = new ApiClient({ token: myToken });
const query = `query { users { account { id show_timeline_weekends tier slug plan { period }}}}`;
const response = await mondayApiClient.request(query);Fields
| Fields | Type | Description | Enum Values |
|---|---|---|---|
| active_members_count | Int | The number of active users on 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. The result is based on the location of the account's first admin. | |
| created_at | Date | The account's creation date. | |
| first_day_of_the_week | FirstDayOfTheWeek! | The account's first day of the week. | monday sunday |
| id | ID! | The account's unique identifier. | |
| is_during_trial | Boolean | Whether the account is in a free trial period. | |
| is_trial_expired | Boolean | Whether the account's trial has expired. | |
| 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. | |
| products | [AccountProduct] | The account's active products. | |
| show_timeline_weekends | Boolean! | Returns true if weekends appear in the timeline. | |
| sign_up_product_kind | String | The product the account first signed up for. | |
| slug | String! | The account's slug. | |
| tier | String | The account's tier. |
