Sign in

v1

latestOpenAPI 3.1.02026-07-224239180.9 KB
Interview Module

Get an interview module member

Returns one employee's membership in the module, including current training status, pause state, limits, and calculated training progress. The module and member must be in the authenticated organization or the request returns not found.

get/v1/interview-modules/{moduleId}/members/{memberId}

Path parameters

moduleIdstring required

an interview module ID. Accepts the canonical prefixed compact UUID, a prefixed dashed UUID, a bare dashed UUID, or a bare compact UUID; input is case-insensitive.

Example:mod_a1b2c3d4e5f64789a1b2c3d4e5f64789
memberIdstring required

an employee ID. Accepts the canonical prefixed compact UUID, a prefixed dashed UUID, a bare dashed UUID, or a bare compact UUID; input is case-insensitive.

Example:emp_a1b2c3d4e5f64789a1b2c3d4e5f64789

Response

Success

training_status'TRAINED' | 'SHADOW' | 'REVERSE_SHADOW' required
next_status'TRAINED' | 'SHADOW' | 'REVERSE_SHADOW' required
shadow_started_atstring date-time nullable required

ISO 8601 timestamp.

reverse_shadow_started_atstring date-time nullable required

ISO 8601 timestamp.

trained_atstring date-time nullable required

ISO 8601 timestamp.

time_to_traininteger required
weekly_interview_limit_overrideinteger nullable required

Member-specific maximum interviews per week; null means unlimited.

progress_percentageinteger required

Example response

{
  "employee": {
    "id": "emp_a1b2c3d4e5f64789a1b2c3d4e5f64789"
  }
}