KEketryx
Training
Preview

Get a user's training status by email

Returns one organization member's full training status: an overall trained flag, the statuses external systems reported, and the per-document breakdown across all of the organization's projects (or one project via projectId) plus the central project, where a project-level document wins over the same central document. Heavier the more projects and documents are in scope, since the whole scope is computed on every call.

get/training/status

Request

Query parameters

startAtinteger

Index to start at. Defaults to 0.

maxResultsinteger

Maximum number of results to return

emailstring email required

Email address of the organization member to query the training status for

projectIdstring

Ketryx ID of the project, e.g., KXPRJ12345

Response

Successful response

startAtinteger required

Index that the pagination started at

maxResultsinteger required

Maximum number of results returned

isTrainedboolean required

Whether the user has no overdue training: no required document in scope is OVERDUE and no external source reports OVERDUE. Computed over the full scope regardless of pagination, and independent of the require-training enforcement switch of each project.

Changes

No recorded changes to this operation across all 1 revision of this API.