cURL
curl --request GET \
--url https://api.buildpass.global/subcontractors/{id} \
--header 'Authorization: Bearer <token>' \
--header 'X-BuildPass-Api-Version: <x-buildpass-api-version>'import requests
url = "https://api.buildpass.global/subcontractors/{id}"
headers = {
"X-BuildPass-Api-Version": "<x-buildpass-api-version>",
"Authorization": "Bearer <token>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {
'X-BuildPass-Api-Version': '<x-buildpass-api-version>',
Authorization: 'Bearer <token>'
}
};
fetch('https://api.buildpass.global/subcontractors/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.buildpass.global/subcontractors/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"X-BuildPass-Api-Version: <x-buildpass-api-version>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.buildpass.global/subcontractors/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-BuildPass-Api-Version", "<x-buildpass-api-version>")
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.buildpass.global/subcontractors/{id}")
.header("X-BuildPass-Api-Version", "<x-buildpass-api-version>")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.buildpass.global/subcontractors/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-BuildPass-Api-Version"] = '<x-buildpass-api-version>'
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"id": "sub_clgbsb90b001qjy0f0eo1hspp",
"createdAt": "2023-10-03T23:19:35.771Z",
"updatedAt": "2023-10-03T23:19:35.771Z",
"name": "Andrews Brick Laying",
"abn": "98765432100",
"isBuilder": false,
"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"
}
]
}{
"errors": [
{
"fieldName": "name",
"message": "This field is required."
}
]
}Subcontractors
Get subcontractor
Get an active subcontractor. Builder-company records require includeBuilderCompany=true.
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>'import requests
url = "https://api.buildpass.global/subcontractors/{id}"
headers = {
"X-BuildPass-Api-Version": "<x-buildpass-api-version>",
"Authorization": "Bearer <token>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {
'X-BuildPass-Api-Version': '<x-buildpass-api-version>',
Authorization: 'Bearer <token>'
}
};
fetch('https://api.buildpass.global/subcontractors/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.buildpass.global/subcontractors/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"X-BuildPass-Api-Version: <x-buildpass-api-version>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.buildpass.global/subcontractors/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-BuildPass-Api-Version", "<x-buildpass-api-version>")
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.buildpass.global/subcontractors/{id}")
.header("X-BuildPass-Api-Version", "<x-buildpass-api-version>")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.buildpass.global/subcontractors/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-BuildPass-Api-Version"] = '<x-buildpass-api-version>'
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"id": "sub_clgbsb90b001qjy0f0eo1hspp",
"createdAt": "2023-10-03T23:19:35.771Z",
"updatedAt": "2023-10-03T23:19:35.771Z",
"name": "Andrews Brick Laying",
"abn": "98765432100",
"isBuilder": false,
"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"
}
]
}{
"errors": [
{
"fieldName": "name",
"message": "This field is required."
}
]
}Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Headers
What API version to use.
Available options:
v1 Example:
"v1"
Path Parameters
Example:
"sub_clgbsb90b001qjy0f0eo1hspp"
Query Parameters
Filter returned statuses by project
Example:
"proj_clgbsb90b001qjy0f0eo1hspp"
Allow the builder's internal company subcontractor record to be returned.
Example:
true
Response
A subcontractor object
Example:
"sub_clgbsb90b001qjy0f0eo1hspp"
Example:
"2023-10-03T23:19:35.771Z"
Example:
"2023-10-03T23:19:35.771Z"
Example:
"Andrews Brick Laying"
Example:
"98765432100"
Whether this is the builder's internal company subcontractor record.
Example:
false
Show child attributes
Show child attributes
Example:
["INVITED", "SWMS_UPLOADED"]
Example:
["bricklayer"]
Show child attributes
Show child attributes