At, we simultaneously support 3 different versions of the API to provide stability for devs while allowing us to improve the API continuously: stable, deprecated, and preview. You can find the list of current versions in our documentation, or you can use the versions API.

As a developer working with, it is important to familiarize yourself with the versions API so you can access all the supported API versions at any time. This document will walk you through the available queries to read the versions object via the API.

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


Querying versions will return metadata about all available API versions. This method does not accept any arguments and returns an array.

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

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

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)));

This query would return the following:

  "data": {
    "versions": [
        "display_name": "Deprecated",
        "kind": "deprecated",
        "value": "2023-07"
        "display_name": "Maintenance",
        "kind": "maintenance",
        "value": "2023-10"
        "display_name": "Current",
        "kind": "current",
        "value": "2024-01"
        "display_name": "Release Candidate",
        "kind": "release_candidate",
        "value": "2024-04"
  "account_id": 1


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

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