Request

Response

    Beta APIs are subject to change. Please avoid using them in production environments.

    Changelog

    This section documents the changes made to the Data Exchange GraphQL API.

    Release Date: 2026-01-09

    Following are the changes made in this release:

    Updated

    • Extended regionalization support to include additional regions: AUS (Australia), IND (India), JPN (Japan), CAN (Canada), GBR (United Kingdom), and DEU (Germany). The API now supports regionalization headers for US, EMEA, AUS, IND, JPN, CAN, GBR, and DEU regions. For more details, see GraphQL Endpoint.

    Release Date: 2025-07-22

    Following are the changes made in this release:

    Added

    • Support for the Australia (AUS) region in addition to the existing US and EMEA regions. For more details, see GraphQL Endpoint.

    Release Date: 2025-01-07

    Following are the changes made in this release:

    Added

    Updated

    • You can now fetch items and exchanges from a folder using the folder query. Previously only exchanges could be retrieved from a folder.

      Earlier version:

      query GetFolder($folderId: ID!) {
          folder(folderId: $folderId) {
              id
              name
              exchanges {
                  results {
                      id
                      name
                      alternativeRepresentations {
                          fileUrn
                      }
                  }
              }
          }
      }
      
      Show More

      Updated version:

      query GetFolder($folderId: ID!) {
          folder(folderId: $folderId) {
              id
              name
              exchanges {
                  results {
                      id
                      name
                      alternativeRepresentations {
                          fileUrn
                      }
                  }
              }
              items {
                  ... on Items {
                      results {
                          id
                          name
                          extensionType
                      }
                  }
              }
          }
      }
      
      Show More

      Note: An Item could be either IFC or Revit file.

    • The type of the units field in the PropertyDefinitions object is changed from String to Object .

      Earlier version:

      query GetPropertyDefinitionOfExchange($exchangeId: ID!) {
          exchange(exchangeId: $exchangeId) {
              id
              name
              propertyDefinitions {
                  results {
                      id
                      name
                      units
                  }
              }
          }
      }
      
      Show More

      Updated version:

      query GetPropertyDefinitionOfExchange($exchangeId: ID!) {
          exchange(exchangeId: $exchangeId) {
              id
              name
              propertyDefinitions {
                  results {
                      id
                      name
                      units {
                          name
                      }
                  }
              }
          }
      }
      
      Show More
    • The type of the value field in the Property object is changed from PropertyData to PropertyValue.

    Deprecated

    Following are the queries, objects, and fields that have been deprecated in this release:

    Deprecated Queries

    Old QueryNew Query
    exchangeByFileId exchangeByFileUrn

    Deprecated Objects

    Old ObjectNew Object
    Definition PropertyDefinition
    ElementAlternativeRepresentations ElementAlternativeIdentifiers
    ExchangeAlternativeRepresentations ExchangeAlternativeIdentifiers
    Lineage ExchangeVersionHistory
    ProjectAlternativeRepresentations ProjectAlternativeIdentifiers

    Deprecated Fields

    Old FieldNew Field
    lineage versionHistory
    alternativeRepresentations alternativeIdentifiers

    Release Date: 2024-05-08

    Beta Updates

    • We now support regionalization within our API through the use of regionalization headers for the US and EMEA regions. For more details, see GraphQL Endpoint.

    Release Date: 2024-04-02

    Beta Updates


    Release Date: 2023-06-12

    Public beta release.


    Release Date: 2022-11-28

    Private beta release.