Articles on: Further information
This article is also available in:

Buildagil openCDE API


The buildagil openCDE API enables developers to interact seamlessly with buildagil and offers numerous roles and tools to facilitate data exchange and integration into existing systems. It is based on the openCDE API specification from BuildingSMART (BCF API / Documents API) and has been extended with additional endpoints, capabilities and fields to provide more flexibility and functionality.


The buildagil openCDE API is aimed at developers or people with programming skills.


Authentication

For authentication to the buildagil openCDE API, please contact support with a callback URL to obtain the client ID and client secret. These credentials are required to authenticate to the buildagil openCDE API.


Authentication is based on the Microsoft Identity Platform and takes place via the OAuth 2.0 authorization code flow with user-based login. Each login is assigned to an individual user accordingly. Further information on the Authorization Code Flow can be found in the following article: Microsoft identity platform and OAuth 2.0 authorization code flow.


Environment

Only the production environment is available for the buildagil openCDE API. The same environment is used for development and testing purposes.


Possibilities

The buildagil openCDE API offers the following options, among others:

  • Call up project information
  • Retrieve, create and edit tasks & topics
  • Retrieve documents and document versions
  • Call up meetings
  • Call up milestones
  • Retrieve user information


The documentation of the buildagil openCDE API can be found under the following link: Documentation buildagil openCDE API


Deep Linking

It is possible to create deep links that provide direct references to specific content within buildagil.

Example: https://app.buildagil.com/open?guid=xxx.


Rate Limits

The buildagil openCDE API uses a user-based, dynamic rate limit. If there are a very high number of requests within a short period of time, these may be throttled based on the user.


openCDE, API, BCF API, OAuth 2.0, Authorization Code Flow, Microsoft Identity Platform, user-based login, Client ID, Client Secret, production environment, test environment, API authentication

Updated on: 12/06/2026