Added

API v3 revision 2026-11-17: interviews and users

Revision 2026-11-17 adds interviews, the company's users, and interview and scorecard templates. Applications and jobs accept four more document types. Send Join-Version: 2026-11-17 to use it.

Companies that existed before this release keep 2026-11-01 as their default, so nothing changes for an existing integration until it sends the new revision. Companies created since default to 2026-11-17.

New endpoints

  • Interviews
    • List interviews (GET /v3/interviews): filter by candidateId, jobId, status, start time or last update. Sort by creation time or by start time. Private interviews and their meeting links are included.
    • Get an interview (GET /v3/interviews/{id}).
    • Create an interview (POST /v3/interviews): invites the candidate to book a slot through a booking link. The interview stays PENDING until they book. Name an interview template to fill every field you leave out.
  • Interview templates: List interview templates (GET /v3/interview-templates) returns active and archived templates and the values an interview created from each one inherits.
  • Scorecard templates: List scorecard templates (GET /v3/scorecard-templates) returns each template's rating attributes and questions in template order. Attribute names follow Accept-Language.
  • Users
    • List users (GET /v3/users): the company's current users, filterable by email or companyRole.
    • Get a user (GET /v3/users/{id}).

New document types

Application documents and a job's application form now accept and return PORTFOLIO, LETTER_OF_RECOMMENDATION, DIPLOMA and VISA (visa or residence permit), in addition to CV and COVER_LETTER. Each type can appear only once per application.

On 2026-11-01, applications and job application forms still return only CV and COVER_LETTER. Other documents are left out.

Endpoint updates

  • Scorecards (GET /v3/scorecards): each scorecard has interviewId, the interview it evaluates, or null for a scorecard written outside an interview. Each attribute has an id that matches the attribute on its scorecard template.
  • Jobs: assign people by user ID. In hiringTeam, send either userId (from List users) or email for each member. To set the contact person, send contactPersonUserId or contactPersonEmail, not both.

Breaking changes in 2026-11-17

These changes apply only when you send Join-Version: 2026-11-17. Update your code before you switch.

Where2026-11-012026-11-17
Job hiringTeam[] role, read and writerolejobRole
Job hiringTeam[].user{ name, email }A user: { id, firstName, lastName, email, position }
Job contactPerson{ name, title, email }A user: { id, firstName, lastName, email, position }
Job hiringTeam[] on create and updateemail requiredExactly one of userId or email

firstName, lastName and position can be null. To show a full name, join the first and last names yourself.

Upgrading

  1. Read Versions and compatibility.
  2. Apply the breaking changes above to your job reads and writes.
  3. Make sure your code accepts the new document types, for example by ignoring types it does not use.
  4. Send Join-Version: 2026-11-17 and test against your company's data before switching production traffic.

To schedule interviews, see Schedule interviews and read their scorecards.