v1

latestOpenAPI 3.1.02026-07-224239180.9 KB
Interview Module

Get an interview module

Returns an interview module's training requirements, graduation configuration, weekly limit, and member counts. The module must belong to the authenticated organization or the request returns not found.

get/v1/interview-modules/{moduleId}

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

Response

Success

idstring required

Canonical interview module ID (mod_ followed by 32 lowercase hexadecimal UUID characters).

namestring required
shadows_requiredinteger required
reverse_shadows_requiredinteger required
graduation_approval'AUTOMATIC' | 'SCHEDULER' | 'CUSTOM' required
weekly_interview_limitinteger nullable required

Maximum interviews per week; null means unlimited.

created_atstring date-time required

ISO 8601 timestamp.

updated_atstring date-time required

ISO 8601 timestamp.

Example response

{
  "id": "mod_a1b2c3d4e5f64789a1b2c3d4e5f64789"
}