Induction registrations

Get one register record

Reads one register record in full — every captured field, the signed acknowledgement snapshot, and a short-lived signed URL for the signature image. Scoped to its project, so `project` is required.

GET
/induction-registrations/{id}

Reads one register record in full — every captured field, the signed acknowledgement snapshot, and a short-lived signed URL for the signature image. Scoped to its project, so project is required.

Authorization

x-api-key<token>

The per-tenant API key, copied from Settings → API & integrations. Sent as the x-api-key request header. The key is tenant-scoped and acts with Admin-equivalent, tenant-wide access.

In: header

Path Parameters

id*string

Resource id.

Query Parameters

projectId*string

The project the record belongs to.

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/induction-registrations/497f6eca-6276-4993-bfeb-53cbbbba6f08?projectId=497f6eca-6276-4993-bfeb-53cbbbba6f08"
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "name": "string",  "company": "string",  "phone": "string",  "signedAt": "2019-08-24T14:15:22Z",  "whiteCardNumber": "string",  "emergencyContactName": "string",  "emergencyContactPhone": "string",  "addressSnapshot": "string",  "acknowledgementSnapshot": {    "intro": "string",    "points": [      "string"    ]  },  "ipAddress": "string",  "signatureUrl": "http://example.com"}
{  "error": {    "code": "unauthorized",    "message": "Missing or invalid API key."  }}
{  "error": {    "code": "not_found",    "message": "Not found."  }}
{  "error": {    "code": "validation",    "message": "One or more inputs are invalid.",    "fields": {      "fieldName": "A message explaining what's wrong with this field."    }  }}

Get a project's induction content GET

Reads the project's site-induction body (markdown) and the acknowledgement wording visitors sign against. Visitor submission stays app-only.

List a project's induction register GET

Lists one project's induction register, most-recent-first, paginated. The register is per-project, so `project` is required.