ATS
Sync / Get Applicant Details from ATS
Automate Candidate Data Flow from ATS to Assessment Platforms
Implementation: Step-by-Step Technical Walkthrough
Step 1: Sync Candidate Data from ATS
Initiate a sync request to pull candidate information from the connected ATS platform. Knit's Sync API retrieves data across six comprehensive candidate models, giving you access to everything from basic contact details to complete work histories.
API Endpoint: POST https://api.getknit.dev/v1.0/sync.start
Request Parameters:
dataType: Set to"ats_candidates"to retrieve candidate informationhonorScheduler(optional): Controls delta sync timing behavior
What You Receive:
The sync operation retrieves data across six candidate models:
- candidate_info: Identity, contact details, professional summary, application IDs
- candidate_education: Degree information, institutions, dates, GPA
- candidate_locations: Complete address details
- candidate_skills: Skill names with proficiency levels
- candidate_experiences: Employment history with dates and descriptions
- candidate_attachments: Resumes, cover letters, and supporting documents
Implementation Note: Syncs must be enabled for the ATS category before making this call. Review Knit's Getting Started documentation to activate sync capabilities for your integration.
Step 2: Extract Relevant Profile Information
Parse the synced candidate data to identify information relevant to your assessment workflows. The structured data models enable you to programmatically access specific fields needed for test routing, evaluator context, and candidate communication.
Key Data Fields for Assessment Platforms:
Identity and Contact (from candidate_info):
firstName,lastName: Personalize assessment invitationsemails: Array with type designation (personal/work) for multi-channel communicationphones: Array with type designation for SMS notificationstitle,company: Current role context for assessment difficulty calibration
Skills and Proficiency (from candidate_skills):
skillName: Technologies, frameworks, methodologiesproficiency: "Expert," "Advanced," "Intermediate," "Beginner"- Use proficiency levels to route candidates to appropriately difficult technical assessments
Education History (from candidate_education):
degreeName,institution: Verify credential claims during background checksmajor,minor: Understand academic background for role fitcurrentlyPursuing: Boolean indicating ongoing education statusscore: GPA or percentage for academic performance context
Work Experience (from candidate_experiences):
company,jobTitle: Professional background contextstartDate,endDate: Years of experience calculationscurrentlyWorking: Boolean for current employment statusdescription: Role summaries and achievement details
Documents (from candidate_attachments):
fileType: RESUME, COVER_LETTER, OFFER_LETTER, NOT_SPECIFIEDdownloadLink: Direct URL to access documents (preferred overlinkfield)attachmentContent: Base64-encoded file content for local storagefileName,createdAt: File metadata
Step 3: Initiate Assessment Workflows
With complete candidate profiles synced from the ATS, automatically trigger relevant assessment workflows without manual recruiter intervention. Use the extracted data to personalize communications, pre-populate assessment forms, and route candidates to appropriate evaluations.
Date Format Note: All date fields in candidate data use ISO 8601 format (YYYY-MM-DD), enabling consistent date calculations across your assessment scheduling and reporting systems.
Key Data Models and APIs Reference
| Component | Description |
|---|---|
| Start a Sync API | POST https://api.getknit.dev/v1.0/sync.start - Initiates data synchronization from ATS platforms. Use dataType: "ats_candidates" to retrieve candidate information across six data models. Supports 40+ ATS platforms. |
candidate_info |
Core candidate identity and contact data including firstName, lastName, phones (array with types), emails (array with types), title, company, links, tags, createdAt, updatedAt, and associated application IDs. |
candidate_education |
Education history including degreeName, institution, fromDate, toDate, major, minor, score/GPA, currentlyPursuing (boolean), and description fields. |
candidate_locations |
Address information with addressLine1, addressLine2, city, state, country, zipCode, and addressType fields following standardized address model structure. |
candidate_skills |
Professional competencies including skillName (e.g., "Python", "React") and proficiency levels ("Expert", "Advanced", "Intermediate", "Beginner"). |
candidate_experiences |
Employment history with company, jobTitle, startDate, endDate, currentlyWorking (boolean), and description containing role summaries and achievements. |
candidate_attachments |
Document files with fileType (RESUME, COVER_LETTER, OFFER_LETTER, NOT_SPECIFIED), fileName, createdAt, downloadLink (preferred), link, and base64-encoded attachmentContent. |
Wrapping Up: Streamline Your Assessment Pipeline
Eliminate Data Entry Bottlenecks
Manual candidate data transfer between ATS and assessment platforms creates delays that frustrate candidates and overwhelm recruiters. By syncing complete candidate profiles automatically, you reduce time-to-assessment from hours to minutes while eliminating transcription errors that damage candidate experience.
Enable Skills-Based Assessment Routing
Access to structured skills data with proficiency levels transforms assessment assignment from a manual triage process into an automated workflow. Route expert developers to advanced system design challenges while directing beginners to foundational assessments—all without recruiter intervention.
Maintain Single Source of Truth
When candidate data flows automatically from ATS to assessment platforms, your recruiting team maintains one authoritative data source instead of juggling disconnected spreadsheets and testing dashboards. Updates to candidate profiles in the ATS instantly reflect in your assessment tools, ensuring evaluators always have current information.
Build Once, Connect Everywhere
Knit's unified API structure means you build candidate data sync workflows once and instantly support 40+ ATS platforms—from enterprise systems like Workday and SAP SuccessFactors to modern platforms like Greenhouse and Lever. Add new ATS integrations without rewriting your core assessment logic.