Account

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 me or users query

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

FieldsTypeDescriptionEnum Values
active_members_countIntThe number of active users on the account (includes active users across all products who are not guests or viewers).
country_codeStringThe account's two-letter country code in ISO3166 format. The result is based on the location of the account's first admin.
created_atDateThe account's creation date.
first_day_of_the_weekFirstDayOfTheWeek!The account's first day of the week.monday sunday
idID!The account's unique identifier.
is_during_trialBooleanWhether the account is in a free trial period.
is_trial_expiredBooleanWhether the account's trial has expired.
logoStringThe account's logo.
nameString!The account's name.
planPlanThe account's payment plan. Returns null for accounts with the multi-product infrastructure.
products[AccountProduct]The account's active products.
show_timeline_weekendsBoolean!Returns true if weekends appear in the timeline.
sign_up_product_kindStringThe product the account first signed up for.
slugString!The account's slug.
tierStringThe account's tier.