Buildlink API

The Buildlink API is based on REST. The API provides a programmatic interface to read and write Buildlink data. API contains all the technical details required by programmers to integrate Buildlink to a custom application.



API Token example

You authenticate to the Buildlink API by providing your API token in the header of the request. You can manage your API token from your account profile. Your API token carries many privileges, so be sure to keep them secret.

API tokens should be treated as secret data and not exposed to users. To ensure the security of access token or API token, we strongly suggest that you make requests to the Buildlink API server-side whenever possible.

All API requests must be made over secure HTTPS. Calls made over plain HTTP are prohibited and will fail. Authentication is required for all requests.

Buildlink developers can do testing using general tools like cURL.


Buildlink API browser

API browser example

Buildlink API browser provides REST API information and API code generation capabilities that help developers in the use of all Buildlink service resources.

Format for the GET request can be API or JSON (format=API, format=json).

Buildlink API browser is available at:


Swagger Autogenerated resource documentation

Swagger example

Swagger is a simple yet powerful representation of your RESTful API. With the largest ecosystem of API tooling on the planet, thousands of developers are supporting Swagger in almost every modern programming language and deployment environment.

With a Swagger-enabled API, you get interactive documentation, client SDK generation and discoverability.

Swagger documentation for Buildlink API is available at: