Skip to main content
POST
Generate a signed interview URL

Authorizations

Authorization
string
header
required

Supabase JWT — Authorization: Bearer <token>.

Body

application/json
type
enum<string>
required

Which kind of signed URL to generate. interview-for-profile: the candidate takes the interview or position (needs interview_profile_id and interview_id); results-for-profile: the candidate sees all their results (needs interview_profile_id); interview-result-candidate: the candidate sees one result (needs interview_result_id); interview-result-talent-seeker: a reviewer sees one result in the recruiter view (needs interview_result_id); interview-results-for-position: a reviewer sees every result of an interview or position (needs interview_id).

Available options:
interview-for-profile,
results-for-profile,
interview-result-candidate,
interview-result-talent-seeker,
interview-results-for-position
merchant_id
string

Company (merchant.id, a uuid) to act for. Honoured for admins and sub-merchant operators only; other callers always use their token's company.

interview_profile_id
string

The candidate (profile_interview.id, a uuid; not a profile.id). Required for interview-for-profile and results-for-profile.

interview_id
string

The interview (interview_def_set.id) or position (position_def_set.id), a uuid. Required for interview-for-profile and interview-results-for-position.

interview_result_id
string

The interview result (interview_result.id), a uuid. Required for interview-result-candidate and interview-result-talent-seeker.

show_menu
boolean

true shows the navigation menu on the page the link opens; false or left out hides it.

Response

The signed URL.

The signed interview URL.

Example:

"https://interviews.example.com/interview/take/<id>/?interview_token=<jwt>&view_hm=true"