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 correct API version for it to run successfully.

🚧
Want data about all available API versions?
Query versions instead!

Queries

Get version

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

Field	Type	Description	Enum Values
display_name	`String!`	The API version's display name.
kind	`VersionKind!`	The type of API version in use.	`current` `deprecated` `maintenance` `previous_maintenance` `release_candidate`
value	`String!`	The API version name. Can be passed in the `API-Version` header.