We support a handful of API versions at any given time to help ensure smooth transitions between version releases. Each version offers different functionality, so you must make requests to the accurate API version for them to run successfully.

As a developer working with monday.com, it is important to familiarize yourself with the version API to know which version was used while making an API call. This document will walk you through the available queries to read the version object via the API.

If you would like to return metadata about all available API versions (not just the one used during the request), you can query the versions object instead.

Queries

Querying version will return metadata about the API version used to make a request. This method does not accept any arguments and returns an object.

You can only query version directly at the root, so it can't be nested within another query.

query {
  version {
    kind
    value
    display_name
  }
}
let query = 'query { version { kind value display_name }}';

fetch ("https://api.monday.com/v2", {
  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)));

This query would return the following:

{
  "data": {
    "version": {
      "display_name": "Release Candidate",
      "kind": "release_candidate",
      "value": "2024-04"
    }
  },
  "account_id": 1
}

Fields

You can use the following field(s) to specify what information your version query will return.

FieldDescription
display_name String!The display name of the API version. Please note that this field is only available in API versions 2024-04 and later.
kind VersionKind!The type of API version in use: stable, deprecated, or preview. Please note that the accepted enum values will change to deprecated, maintenance, current, or release_candidate in API versions 2024-04 and later. You can read more about this change here.
value String!The API version name as a string that can be passed in the API-Version header.

πŸ“˜

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