All monday.com users must either join an existing account or create a new one. On the account level, users can invite other users to join the account, specify their primary use of the platform, sign up for a plan, and more!

Queries

You can use the account query to retrieve account data via the API.

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

query {
  users {
    account {
      id
      show_timeline_weekends
      tier 
      slug
      plan {
        period
      }
    }
  }
}

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

You can use the following fields to specify what information your account query will return. Some fields support their own subfields.

Fields	Description	Enum Values	Supported Subfields
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. The result is based on the location of the account's first admin.
first_day_of_the_week `FirstDayOfTheWeek!`	The account's first day of the week.	`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!`	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.