GET
/
subcontractors
cURL
curl --request GET \
  --url https://api.buildpass.global/subcontractors \
  --header 'Authorization: Bearer <token>' \
  --header 'X-BuildPass-Api-Version: <x-buildpass-api-version>' \
  --header 'X-BuildPass-Builder-Id: <x-buildpass-builder-id>'
{
  "data": [
    {
      "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"
        }
      ]
    }
  ],
  "meta": {
    "totalCount": 100,
    "totalPages": 4,
    "offset": 0,
    "limit": 25
  }
}

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 <= 100
Example:

25

​
projectId
string

Filter subcontractors for a specific project

Example:

"proj_clgbsb90b001qjy0f0eo1hspp"

Response

200
application/json

A list of subcontractors

The response is of type object.