Warning messages now included in API responses

We've added warning messages to a number of our API calls!

Our GraphQL API will now return an extensions object with a list of warnings, when you try using an object that is going to be deprecated or changed soon.

Please store these values to give clarity on what functions need to be changed. This is especially relevant for apps migrating to API version 2023-10.

📘

Note: Do not rely solely on warnings to understand what is updating – you should always use our API changelog and release notes as the source of truth.

Example usage

Let's say I use the items_by_column_values query, which will be deprecated in 2023-10:

query {
  items_by_column_values(board_id:12345, column_id:numbers, column_value:"5000") {
    id
    name
  }
}

The response will contain an extensions object, with a warning that this is being deprecated. It also contains metadata such as what part of my query is deprecated, and a code to explain the cause of the warning.

Here's what it looks like:

{
  "data": {
    "items_by_column_values": [
      {
        "id": "4579863854",
        "name": "Develop messaging"
      }
    ]
  },
  "extensions": {
    "warnings": [
      {
        "message": "Replaced by Query.items_page_by_column_values since 2023-10",
        "locations": [
          {
            "line": 2,
            "column": 3
          }
        ],
        "path": [
          "query",
          "items_by_column_values"
        ],
        "extensions": {
          "code": "deprecatedField",
          "typeName": "Query",
          "fieldName": "items_by_column_values"
        }
      }
    ]
  },
  "account_id": 12345
}

Have questions? Post them in our developer community!