API version [2024-04] contains the following breaking changes to the app_installs object:

1. The [app_id] field type will change from Int! to ID!
2. On the [app_install_user] field, the id field will change from Int to ID
3. On the [app_install_account] field, the id field will change from Int! to ID!

query {
  app_installs (app_id: 123456, account_id: 98766543210) {
    app_id
    app_install_account {
      id
    }
    app_install_user {
      id
    }
  }
}

As part of a gradual multi-product migration, users will eventually be able to return the ID of the main workspace instead of null (read more here).

We added the is_default_workspace field to API versions 2024-04 and later to help identify which workspace is the main one. This field returns true if a workspace is the main one or false if it isn't.

query {
  workspaces {
    id
    is_default_workspace
    name
  }
}

We recently added the relative_to and position_relative_method arguments to the create_item mutation to specify the location of the new item.

• relative_to: Accepts an item ID to specify which item to create the new one in relation to.
• position_relative_method: Accepts enum values to specify if the new item should be created above or below the relative_to value.

These arguments are only available in API versions 2024-04 and later.

mutation {
  create_item (board_id: 1234567890, group_id: "group_one", item_name: "new item", position_relative_method: before_at, relative_to: 9876543210, column_values: "{\"date\":\"2023-05-25\"}") {
    id
  }
}

Our API documentation has a new start page! We built it to improve the navigation experience of our docs.

PS: This is part of a larger effort to improve the usability of our docs. If you have any feedback or a wishlist for our documentation, please share it in the developer community!

We recently added a new argument and a new field on the app_installs object. These are only available in API versions 2024-04 and later.

• The account_id argument filters app installations by a specific account using the account ID.
• The permissions field returns the required and approved scopes for an app installation.

query {
  app_installs (app_id: 123456789, account_id: 98766543210) {
    app_id
    timestamp
    app_install_account {
      id
    }
    app_install_user {
      id
    }
    app_version {
      major
      minor
      patch
      type
      text
    }
    permissions {
      approved_scopes
      required_scopes
    }
  }
}

In API versions 2024-04 and later, the kind field accepted enum values on version and versions queries have changed.

The table below shows the accepted enums in versions 2024-01 and earlier, as well as those in versions 2024-04 and later. This is considered a breaking change, so please act accordingly.

In API versions 2024-04 and later, you can query the display_name field on both version and versions to return the API version's display name.

query {
  version {
    display_name
    kind
    value
  }
}

❗️

No more extensions

As of March 5th, customers can no longer request an extension. All customers must migrate to a new API version as we near the March 18th deadline.

Any customers who requested an extension to use API version 2023-07 can keep using it until March 18th 2024.

This only applies to folks who requested an extension. If you didn't request one, your account may switch over to 2024-01 at any point.

Why are we doing this?

As you know, we are gradually making version 2024-01 the default version when using the API.

As of today (Feb 19th), some apps and accounts are using version 2023-07 as the default API version and others are using 2024-01.

The original extension date was Feb 15th, but we are giving folks more time – to March 18th. Since the change has been very gradual, we believe that postponing the deadline is the most fair option.

Can I still get an extension?

Yes, if you have not prepared your app for the breaking changes, you may request an extension using these instructions.

We recently released two new query parameters that allow you to retrieve the schema for a specific API version or the SDL version of the schema.

API version

By default, the schema is in introspection JSON format for the Current API version. You can request the schema for a different version using the optional version=<API-Version> parameter with the version name.

For example https://api.monday.com/v2/get_schema?version=2024-04

SDL version

You can also retrieve the schema definition language (SDL) version using the optional format=sdl parameter.

For example https://api.monday.com/v2/get_schema?format=sdl

The new group_color argument allows you to specify a group's color when using the create_group mutation. You can find a list of the accepted values here.

This argument is available in API versions 2024-04 and later.

mutation {
  create_group (board_id: 1234567890, group_name: "new group", group_color: "#ff642e", relative_to: "test_group", position_relative_method: before_at) {
    id
  }
}

let query = "mutation { create_group (board_id: 1234567890, group_name: \"new group\", group_color: \"ff642e\", relative_to: \"test group\", position_relative_method: before_at) { id } }";

fetch ("https://api.monday.com/v2", {
  method: 'post',
  headers: {
    'Content-Type' : 'application/json',
    'Authorization' : 'YOUR_API_KEY_HERE',
    'API-Version' : '2024-04'
   },
   body: JSON.stringify({
     query : query
   })
  })
   .then(res => res.json())
   .then(res => console.log(JSON.stringify(res, null, 2)));