Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

X-BuildPass-Builder-Id
string
required

Call the /builders endpoint to get a builder ID

Example:

"buil_clgbsb90b001qjy0f0eo1hspp"

X-BuildPass-Api-Version
enum<string>
default:v1
required

What API version to use.

Available options:
v1
Example:

"v1"

Query Parameters

offset
integer
default:0

The number of items to skip before starting to collect the result set.

Example:

0

limit
integer
default:25

The number of items to return.

Required range: x <= 25
Example:

25

projectId
string

Filter subcontractors for a specific project

Example:

"proj_clgbsb90b001qjy0f0eo1hspp"

includeBuilderCompany
boolean
default:false

Include the builder's internal company subcontractor record. Use the response isBuilder field to identify it.

Example:

true

Response

A list of subcontractors

data
object[]
meta
object