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-Api-Version
enum<string>
default:v1
required

What API version to use.

Available options:
v1
Example:

"v1"

Path Parameters

id
string
required
Example:

"sub_clgbsb90b001qjy0f0eo1hspp"

Query Parameters

projectId
string

Filter returned statuses by project

Example:

"proj_clgbsb90b001qjy0f0eo1hspp"

includeBuilderCompany
boolean
default:false

Allow the builder's internal company subcontractor record to be returned.

Example:

true

Response

A subcontractor object

id
string
Example:

"sub_clgbsb90b001qjy0f0eo1hspp"

createdAt
string<date-time>
Example:

"2023-10-03T23:19:35.771Z"

updatedAt
string<date-time>
Example:

"2023-10-03T23:19:35.771Z"

name
string
Example:

"Andrews Brick Laying"

abn
string
Example:

"98765432100"

isBuilder
boolean

Whether this is the builder's internal company subcontractor record.

Example:

false

address
object
statuses
array
Example:
tags
string[]
Example:
integrations
object[]