> ## Documentation Index
> Fetch the complete documentation index at: https://developer.buildpass.global/llms.txt
> Use this file to discover all available pages before exploring further.

# 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

<CardGroup cols={2}>
  <Card title="Authentication" icon="shield" href="/features/authentication">
    Learn how to generate an OAuth2 token to authenticate your requests.
  </Card>

  <Card title="Filtering" icon="filter" href="/features/filtering">
    Use filters to return a subset of data in our list queries.
  </Card>

  <Card title="Pagination" icon="page" href="/features/pagination">
    Learn how to paginate through our list queries.
  </Card>

  <Card title="Versioning" icon="copy" href="/features/versioning">
    Learn how to version your requests to ensure compatibility.
  </Card>

  <Card title="Rate limiting" icon="bolt" href="/features/rate-limiting">
    Learn how we rate limit our requests to prevent abuse.
  </Card>

  <Card title="Changelog" icon="clock" href="/changelog">
    View the latest changes and improvements to the BuildPass API.
  </Card>
</CardGroup>

## 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.

<CardGroup cols={2}>
  <Card title="List builders" icon="building" href="/api-reference/builders/list">
    List the builders you have access to.
  </Card>

  <Card title="List projects" icon="diagram-project" href="/api-reference/builders/projects/list">
    List the projects for a builder.
  </Card>

  <Card title="List meetings" icon="calendar-days" href="/api-reference/builders/meetings/list">
    List meetings for a builder with project, status, and date filters.
  </Card>

  <Card title="List photos" icon="images" href="/api-reference/builders/photos/list">
    List gallery photos for a builder and retrieve signed image URLs.
  </Card>

  <Card title="List subcontractors" icon="user-helmet-safety" href="/api-reference/subcontractors/list">
    List the subcontractors under a builder access to.
  </Card>

  <Card title="List insurances" icon="file" href="/api-reference/subcontractors/insurances/list">
    List insurance documents for a subcontractor.
  </Card>

  <Card title="List prequalifications" icon="check" href="/api-reference/subcontractors/prequalifications/list">
    List the prequalifications for a subcontractor.
  </Card>

  <Card title="List timesheets" icon="clock" href="/api-reference/timesheets/list">
    List timesheets for a builder with filtering options.
  </Card>

  <Card title="List SWMS documents" icon="file-shield" href="/api-reference/subcontractors/swms/list">
    List Safe Work Method Statements for a subcontractor.
  </Card>
</CardGroup>