We support a handful of API versions at any given time to help ensure smooth transitions between version releases. Each version functions differently, so your request must be to the accurate API version in order for it to run successfully.

🚧

Want data about all available API versions?

Query the version endpoint instead!

Queries

You can use the version query to retrieve data about the version via the API.

• Returns an object containing metadata about the API version used to make a request
• Can only be queried directly at the root; can't be nested within another query

query {
  version {
    kind
    value
    display_name
  }
}

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

Fields

You can use the following fields to specify what information your version query will return.