Buildr’s API allows developers to integrate their systems with the Buildr CRM to create fully-integrated solutions that supercharge their workflows. This guide will walk you through the steps required to get started with the Buildr API.

​
Beta Service

The Buildr API is currently provided to Buildr customers as a Beta Service.

​
Prerequisites

Before you can get started with the Buildr API, you’ll need the following:

  • A Buildr account with API access enabled
  • Basic knowledge of REST APIs and JSON
  • A tool for making API requests (such as Postman or cURL)

​
API Basics

The Buildr API is a RESTful API that communicates using JSON. The API supports a range of endpoints for managing opportunities, contacts, companies, and more. Additionally, the API supports webhooks, allowing your application to receive real-time notifications of changes to your Buildr data.

​
Authentication

All API requests to Buildr require authentication using OAuth2. The Buildr API supports the Authorization Code Grant flow and the Client Credentials Grant flow. You’ll need to obtain an access token to make API requests.

​
Using the API

Once you have an access token, you can start making API requests. The API documentation provides full details on the available endpoints and their usage. You can use any HTTP client library to make API requests, such as cURL or a programming language’s built-in HTTP client.

Here is an example API request using cURL:

curl -X GET \
  https://api.buildr.com/companies \
  -H 'Authorization: Bearer <access_token>'

In this example, the API endpoint /companies is being requested using the HTTP GET method. The Authorization header contains the access token obtained using OAuth2.

​
Webhooks

Buildr supports webhooks, which allow your application to receive real-time notifications of changes to your Buildr data. To use webhooks, you’ll need to configure a webhook endpoint URL in your Buildr account. Buildr will then send a POST request to your endpoint URL whenever a relevant event occurs.

Here is an example webhook payload:

{
  "id": "123",
  "url": "https://api.buildr.com/a/1/opportunities/123",
}

In this example, an opportunity with the ID 123 and the name Opportunity X has been created. Your application can use this information to update its own data accordingly.

​
Conclusion

The Buildr API provides a flexible and powerful platform for integrating your systems with the Buildr CRM. With the ability to customize and extend the entire construction workflow, and the reliability and scalability of the ConstructionOS infrastructure, the Buildr API is a great choice for building modern, integrated solutions.