Skip to main content
GET
/
subcontractors
/
{id}
/
insurances
cURL
curl --request GET \
  --url https://api.buildpass.global/subcontractors/{id}/insurances \
  --header 'Authorization: Bearer <token>' \
  --header 'X-BuildPass-Api-Version: <x-buildpass-api-version>'
import requests

url = "https://api.buildpass.global/subcontractors/{id}/insurances"

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}/insurances', 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}/insurances",
  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}/insurances"

	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}/insurances")
  .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}/insurances")

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
{
  "data": [
    {
      "id": "doc_clgbsb90b001qjy0f0eo1hspp",
      "createdAt": "2023-10-03T23:19:35.771Z",
      "updatedAt": "2023-10-03T23:19:35.771Z",
      "expiry": "2023-10-03T23:19:35.771Z",
      "name": "Safety Certificate",
      "customType": "SDS",
      "status": "WAITING_REVIEW",
      "url": "<string>"
    }
  ],
  "meta": {
    "totalCount": 100,
    "totalPages": 4,
    "offset": 0,
    "limit": 25
  }
}
{
  "errors": [
    {
      "fieldName": "name",
      "message": "This field is required."
    }
  ]
}

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

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

type
enum<string>

Filter insurances by type

Available options:
PUBLIC_LIABILITY,
WORK_COVER,
OTHER
Example:

"SWMS"

status
enum<string>

Filter insurances by status

Available options:
CHANGES_REQUESTED,
REVIEWED,
WAITING_REVIEW,
EXPIRED
Example:

"EXPIRED"

customType
string

Filter insurances by custom type

Example:

"SDS"

Response

A list of insurances

data
object[]
meta
object