BuildPass API home pagelight logodark logo
  • Support
  • Admin app
  • Admin app
Documentation
API Reference
BuildPass API
  • Introduction
Features
  • Authentication
  • Filtering
  • Pagination
  • Versioning
  • Rate limiting
On this page
  • Get started
  • API features
  • Start integrating
BuildPass API

Introduction

BuildPass API Documentation

​
Get started

To get started, you will need to reach out to the BuildPass team to get your client ID and client secret, which you can then use to generate an OAuth token.

​
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 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.
Authentication
Powered by Mintlify
Assistant
Responses are generated using AI and may contain mistakes.