Skip to main content
GET
/
builders
/
{builderId}
/
projects
/
{projectId}
/
inductions
/
{identifierOrId}
cURL
curl --request GET \
  --url https://api.buildpass.global/builders/{builderId}/projects/{projectId}/inductions/{identifierOrId} \
  --header 'Authorization: Bearer <token>' \
  --header 'X-BuildPass-Api-Version: <x-buildpass-api-version>'
{
  "id": "ind_clgbsb90b001qjy0f0eo1hspp",
  "identifier": 1,
  "createdAt": "2023-10-03T23:19:35.771Z",
  "updatedAt": "2023-10-03T23:19:35.771Z",
  "type": "PROJECT_INDUCTION",
  "status": "WAITING_REVIEW",
  "project": {
    "id": "prj_clgbsb90b001qjy0f0eo1hspp",
    "name": "Downtown Mall Construction"
  },
  "worker": {
    "id": "wkr_clgbsb90b001qjy0f0eo1hspp",
    "fullName": "John Doe"
  },
  "subcontractor": {
    "id": "sub_clgbsb90b001qjy0f0eo1hspp",
    "name": "ABC Contractors"
  },
  "data": [
    {
      "name": "Emergency Contact",
      "type": "text",
      "value": "<any>"
    }
  ]
}

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

​
builderId
string
required

The ID of the builder

Example:

"buil_clgbsb90b001qjy0f0eo1hspp"

​
projectId
string
required

The ID of the project

Example:

"prj_clgbsb90b001qjy0f0eo1hspp"

​
identifierOrId
string
required

The project-specific identifier (numeric, e.g. 5) or the induction ID (with ind_ prefix, e.g. ind_abc123)

Example:

"5"

Response

An induction object with form data

​
id
string

The ID of the induction

Example:

"ind_clgbsb90b001qjy0f0eo1hspp"

​
identifier
number | null

The project-specific identifier for the induction

Example:

1

​
createdAt
string<date-time>
Example:

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

​
updatedAt
string<date-time>
Example:

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

​
type
enum<string>
Available options:
BUILDER_INDUCTION,
PROJECT_INDUCTION
Example:

"PROJECT_INDUCTION"

​
status
enum<string>
Available options:
REVIEWED,
WAITING_REVIEW,
CHANGES_REQUESTED
Example:

"WAITING_REVIEW"

​
project
object | null
​
worker
object
​
subcontractor
object | null
​
data
object[] | null

Array of capture fields with user-provided data from the induction form