Skip to main content

​
Get started

If you are on a Pro plan, you can create your own API credentials in the BuildPass Admin app. There is no need to contact us first.
  1. Sign in to the BuildPass Admin app for your region:
  2. Go to Settings → API access.
  3. Select Create API client and enter a name for the integration.
  4. Copy the Client ID and Client secret before you close the dialog.
The client secret is only shown once, when the client is created. Store it somewhere secure. If you lose it, create a new API client and revoke the old one.
Credentials belong to the region you created them in. Requests made with them must target that same region using the X-BuildPass-Region-Id header — see Multi-region.
Use those credentials to generate an OAuth token, then start making requests. If you are not on a Pro plan, or you are an integrator building an application for BuildPass customers, contact BuildPass support and we will provision credentials for you.

​
API features

Authentication

Learn how to generate an OAuth2 token to authenticate your requests.

Filtering

Use filters to return a subset of data in our list queries.

Pagination

Learn how to paginate through our list queries.

Versioning

Learn how to version your requests to ensure compatibility.

Rate limiting

Learn how we rate limit our requests to prevent abuse.

Changelog

View the latest changes and improvements to the BuildPass API.

​
Start integrating

Once you have your client ID and client secret, you can generate an authentication token and begin to integrate with the BuildPass API.

List builders

List the builders you have access to.

List projects

List the projects for a builder.

List meetings

List meetings for a builder with project, status, and date filters.

List photos

List gallery photos for a builder and retrieve signed image URLs.

List subcontractors

List the subcontractors under a builder access to.

List insurances

List insurance documents for a subcontractor.

List prequalifications

List the prequalifications for a subcontractor.

List timesheets

List timesheets for a builder with filtering options.

List SWMS documents

List Safe Work Method Statements for a subcontractor.