Added
1.0.27
6 days ago by Adam Mazur
Applications (api/v1/applications)
api/v1/applications)- Added
country_code,country_code_alpha3, andcountry_nameattributes — expose the candidate's country of residence in ISO formats (Apr 2025) - Added
admin_pdf_applicationattachment — download the PDF version of the application form (Jun 2025) - Added
create_pdf_applicationwrite-only boolean — trigger async generation of a PDF application (Jun 2025) - Made
commentsassociation writable — you can now create/update/delete comments on an application via the API (Jun 2025) - Added
cover_letterandpdf_cover_letterfile attachments (Oct 2025) - Added
document_requestssideload — fetch document requests (and their answers) attached to an application (Oct 2025) - Fixed: duplicate candidate validation is now enforced at API creation time — if company settings disallow duplicate candidates, the API returns a clear error instead of silently creating and then obfuscating the record (Nov 2025)
- Updated
tagsattribute handling to use the correct tagging write interface (add_tag_with_context,add_tags_with_context,remove_tag_with_context) (Nov 2025)
Candidates (api/v1/candidates)
api/v1/candidates)- Added
tagsattribute (read) andhris_idextra attribute (May 2025) - Added
hris_referencesideload — fetch the candidate's HRIS export record (May 2025) - Sideloading
?include=applicationsnow uses an efficient query path with a cap of 1000 applications per record; when the limit is hit, the response includesmeta.applications_truncated: trueandmeta.applications_limit_per_record(Jan 2026)
Comments (api/v1/comments)
api/v1/comments)- Added
Candidateas a supportedcommentable_type— comments can now be sideloaded, created and filtered by candidate (Aug 2025)
Answers (api/v1/answers)
api/v1/answers)- Added file attachment support — answers can now carry file attachments via active storage (Apr 2025)
- Answers accessible when sideloading document requests on Applications (
?include=document_requests.answers) (Jan 2026)
Interviews (api/v1/interviews)
api/v1/interviews)- Added
presenceattribute (attended/no_show) and a corresponding filter — distinguish outcome for completed interviews (Mar 2025) - Interviews endpoint enabled —
index,show, andupdateoperations now available (Jul 2025)
Jobs (api/v1/jobs)
api/v1/jobs)- Added
on_hold_in_secondsattribute — cumulative time (in seconds) the job has been on hold, including the current hold period if active (Mar 2025) - Added
job_postings.locationsideload — fetch job postings with full location details directly from the job (Nov 2025) - Added
onboarding_process_idattribute — expose which onboarding process is assigned to the job (Jan 2026) - Added
users_emails_with_job_level_visibilityextra attribute (read/write) — read or set the list of user emails with job-level visibility; writing replaces the existing set (Mar 2026) - Added
all_users_emails_with_job_visibilityextra attribute (read-only) — returns all users (including those with company-wide access) who can see the job (Mar 2026)
Job Postings (api/v1/job_postings)
api/v1/job_postings)- Added
job_idfilter — query job postings by job directly (Nov 2025) - Job postings now expose full location details when sideloaded from Jobs (Nov 2025)
Job Seekers (api/v1/job_seekers)
api/v1/job_seekers)- Added create, update, and delete operations — job seekers were previously read-only; all standard attributes (
first_name,last_name,email,phone,address,channel,locale, etc.) are now writable (Feb 2026) - Added CV upload support via
cv_base64_dataandcv_base64_filenamewrite-only attributes (Mar 2026) - Added tag write support:
add_tag_with_context,add_tags_with_context, andremove_tag_with_contextwrite-only attributes, matching the interface on Applications (Mar 2026) - Added
user_scorecardssideload — fetch scorecards grouped by user directly from a job seeker (Oct 2025)
Onboarding Applications (api/v1/onboarding_applications)
api/v1/onboarding_applications)- Improved status handling for Onboarding v2 — the API now detects which onboarding version is active and correctly infers
statusfor v2 applications that use a different completion model (Sep 2025)
Onboarding Answers (api/v1/onboarding_answers)
api/v1/onboarding_answers)- Added
document_requestassociation — sideload the document request linked to an onboarding answer (Jan 2026)
Requisitions (api/v1/requisitions)
api/v1/requisitions)- Added
creator_idandcreator_emailwrite attributes — specify the creator when creating a requisition; falls back to the company system user when neither is provided (Mar 2026)
Requisition Template Fields (api/v1/requisition_template_fields)
api/v1/requisition_template_fields)required(boolean) replaced withrequirement_levelenum — values:optional,required,recommended(Apr 2025)requiredattribute re-added as a computed boolean for backwards compatibility (Apr 2025)
Scorecards (api/v1/scorecards)
api/v1/scorecards)- Added
scorecard_notesassociation — sideload free-text notes attached to a scorecard (Jun 2025)
Scorecard Answers (api/v1/scorecard_answers)
api/v1/scorecard_answers)- Added
boolean_answerattribute — boolean-type scorecard answers are now exposed (Jun 2025)
User Scorecards (api/v1/user_scorecards)
api/v1/user_scorecards)- New resource —
UserScorecardendpoint added, giving access to scorecards grouped by user; accessible as a sideload from Applications and Job Seekers (Oct 2025) - Scorecard sub-resources (
scorecard_answers,scorecard_notes,scorecard_ratings) are read-only when accessed via the API (Oct 2025)
HRIS Exports (api/v1/hris_exports)
api/v1/hris_exports)- Added
created_atandupdated_attimestamps (May 2025) - Added as a sideloadable
hris_referenceassociation from Applications and Candidates (May 2025)
Users (api/v1/users)
api/v1/users)- Added update (PUT) endpoint — update user attributes via the API (Feb 2026)
- Update endpoint supports setting
access_groupmembership (Mar 2026)
Custom Attributes (api/v1/custom_attributes)
api/v1/custom_attributes)- Fixed:
select-type custom attribute values are now correctly translated - Improved validation error messages for invalid custom attribute values (Mar 2026)
