All users must either join an existing account or create a new one. Users can do many things on the account-level, including inviting other users to join the account, specifying their primary use of the platform, or signing up for a plan.

As a developer working with, it is important to familiarize yourself with the account API so you know how to access account data. This document will walk you through the available queries read the account object via the API.


Required scope: account:read

Querying account will return metadata about a specific account. This method does not accept any arguments and returns an object.

You can query accounts directly at the root or nest it within a me or users query.

query {
  users {
    account {
      plan {
let query = "query { users { account { id show_timeline_weekends tier slug plan { period }}}}";

fetch ("", {
  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)));


You can use the following field(s) to specify what information your account query will return. Please note that some fields will have their own fields.

FieldsDescriptionSupported fields
country_code StringThe 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: Sunday or Monday.
id ID!The account's unique identifier.
logo StringThe account's logo.
name String!The account's name.
plan PlanThe account's payment plan.max_users Int!
period String
tier String
version Int!
products [AccountProduct]The account's active Int
kind AccountProductKind (core, marketing, crm, software, forms, whiteboard, or project_management)
show_timeline_weekends Boolean!Shows true if weekends appear in the timeline.
sign_up_product_kind StringThe product the account first signed up to.
slug String!The account's slug.
tier StringThe account's tier.


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! 😎