Skip to main content
GET
/
subcontractors
/
{id}
cURL
curl --request GET \
  --url https://api.buildpass.global/subcontractors/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'X-BuildPass-Api-Version: <x-buildpass-api-version>'
{
  "id": "sub_clgbsb90b001qjy0f0eo1hspp",
  "createdAt": "2023-10-03T23:19:35.771Z",
  "updatedAt": "2023-10-03T23:19:35.771Z",
  "name": "Andrews Brick Laying",
  "abn": "98765432100",
  "address": {
    "street": "123 Fake Street",
    "suburb": "Springfield",
    "state": "QLD",
    "postcode": "4000",
    "country": "Australia"
  },
  "statuses": [
    "INVITED",
    "SWMS_UPLOADED"
  ],
  "tags": [
    "bricklayer"
  ],
  "integrations": [
    {
      "type": "PROCORE",
      "sourceId": "1234567890",
      "companyId": "1234567890"
    }
  ]
}

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.

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"

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"

​
address
object
​
statuses
array
Example:
["INVITED", "SWMS_UPLOADED"]
​
tags
string[]
Example:
["bricklayer"]
​
integrations
object[]