Skip to main content
GET
Get an interview module member
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

employee
object
required
training_status
enum<string>
required
Available options:
TRAINED,
SHADOW,
REVERSE_SHADOW
next_status
enum<string>
required
Available options:
TRAINED,
SHADOW,
REVERSE_SHADOW
paused
object
required
shadow_started_at
string<date-time> | null
required

ISO 8601 timestamp.

reverse_shadow_started_at
string<date-time> | null
required

ISO 8601 timestamp.

trained_at
string<date-time> | null
required

ISO 8601 timestamp.

time_to_train
integer
required
Required range: x >= 0
weekly_interview_limit_override
integer | null
required

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

progress_percentage
integer
required
Required range: 0 <= x <= 100
training_progress
object
required