Induction registrations

List a project's induction register

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

GET
/induction-registrations

Lists one project's induction register, most-recent-first, paginated. The register is per-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

Query Parameters

limit?integer

Page size, 1–200. Defaults to 50.

cursor?string

Opaque cursor from a previous page's nextCursor. Omit for the first page.

projectId*string

The project whose register to list.

Response Body

application/json

application/json

application/json

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