Skip to main content
GET
Get interview module member stats
Beta: this endpoint may change or be removed without notice while in beta. There is no compatibility promise until it reaches general availability.

Authorizations

Authorization
string
header
required

API tokens are passed as Bearer tokens.

Path Parameters

moduleId
string
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.

Pattern: ^(?:mod_)?(?:[0-9a-fA-F]{32}|[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
Example:

"mod_a1b2c3d4e5f64789a1b2c3d4e5f64789"

memberId
string
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.

Pattern: ^(?:emp_)?(?:[0-9a-fA-F]{32}|[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
Example:

"emp_a1b2c3d4e5f64789a1b2c3d4e5f64789"

Response

Success

Detailed training progress for one member in one interview module, including completed and upcoming interviews, remaining requirements, and pause state.

completed
integer
required
upcoming
integer
required
completed_as_shadow
integer
required
completed_as_reverse_shadow
integer
required
completed_as_interviewer
integer
required
manual_completed_as_shadow
integer
required
manual_completed_as_reverse_shadow
integer
required
manual_completed_as_interviewer
integer
required
training_status
enum<string>
required
Available options:
TRAINED,
SHADOW,
REVERSE_SHADOW
trainings_to_pass
integer
required
shadows_required
integer
required
reverse_shadows_required
integer
required
shadow_offset
integer
required
reverse_shadow_offset
integer
required
current_training_session
string | null
required
current_training_session_status
enum<string>
required
Available options:
NONE,
SCHEDULED,
REQUIRED_INTERVIEWS_SCHEDULED,
UNSCHEDULED,
NEEDS_APPROVAL
paused
object
required