Skip to main content
Most mistakes when driving JobMojito come from using the wrong id in the wrong field. This page is the reference: what each id means, which tool/endpoint returns it, and which field expects it. When you’re unsure which id to pass, come back here rather than guessing.
The same interview lives under three different field names depending on the endpoint (interview_def_set_id, position_id, interview_id), and result endpoints need interview_result_id — not the result row’s id. See The interview id has three names and Result ids below.

​
The key ids

​
The interview id has three names

When you create an interview you get back an interview_def_set_id. That same value is what every “which interview?” field wants — but the field is named differently per endpoint. Don’t be thrown by the different names:
position_id and interview_id both accept either an interview-definition id or a position id — for the common case they’re the same value you got back as interview_def_set_id.

​
Result ids

list_interview_results returns rows with several ids. Use the right one:
  • interview_result_id — the id you pass to get_interview_result_details (GET /job-interview-details, as the query param interview_result_id) and to generate_interview_report (POST /job-interview-pdf). This is the one you almost always want.
  • id — the position result row id. Not accepted by the detail/report endpoints; don’t use it there.
  • profile_interview_id — the candidate id (same family as list_candidates.id).
  • interview_result_pre_screening_id — the pre-screening result, when present.
There is no link-building tool. To let a user open something in the JobMojito admin app, construct the URL from the right id and present it as a clickable Markdown link. Base: https://app.jobmojito.com. URL-encode ids that contain spaces or other reserved characters. If you only have a name, resolve the id first (next section), then build the link.

​
Finding an id when you only have a name

You have two options:
  1. Ask the API. The list tools accept a filter_text query parameter — e.g. list_interviews(filter_text="Backend Engineer"), list_candidates(filter_text="peter@…"), list_interview_results(filter_text="…") — then read the id from the matching row (mind which id for results).
  2. Use the admin UI. In app.jobmojito.com: interviews live under Interview Creator, candidates under Candidates, and completed interviews under Interview Results. Each list has a search box; open the item and its id is the last segment of the page URL (matching the link patterns above).