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 with 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 greater flexibility and functionality.


The buildagil openCDE API is intended for developers or individuals with programming skills.


Authentication
To authenticate with the buildagil openCDE API, please contact support and provide a callback URL to receive your client ID and client secret. These credentials are required to authenticate with the buildagil openCDE API.


Authentication is based on the Microsoft Identity Platform and is performed using the OAuth 2.0 authorization code flow with user-based login. Each login is associated with a single user. For more information on the authorization code flow, see the following article: Microsoft Identity Platform and the OAuth 2.0 authorization code flow.


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


Options
The buildagil openCDE API offers the following capabilities, among others:

  • View project information
  • View, create, and update tasks and topics
  • Retrieve, upload, move, and update documents
  • Retrieve document versions
  • Retrieve and update document metadata
  • View meetings
  • View milestones
  • Retrieve user information


You can find the documentation for the buildagil openCDE API at the following link: Buildagil openCDE API Documentation


Deep Linking
It is possible to create deep links that provide direct access 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 a very large number of requests are made within a short period of time, they may be throttled on a per-user basis.


openCDE, API, BCF API, OAuth 2.0, Authorization Code Flow, Microsoft Identity Platform, User-Based Sign-In, Client ID, Client Secret, Production Environment, Test Environment, API Authentication

Updated on: 24/06/2026