API Reference
Signup For Free
Start typing to search…

Candidate Data Models

📘

Use data type ats_candidatesin the Sync APIs to get these models

Here are the different models you can subscribe to while doing a sync:

Model IDEvent Data KeyDescription
candidate_infoinfoGet basic candidate details such as name, contact information, current role, and associated tags.
candidate_educationeducationGet education details including degree, institute, major, score, and duration.
candidate_locationslocationsGet the candidate’s location details such as address, city, state, country, and postal code.
candidate_skillsskillsGet the list of skills associated with the candidate and their proficiency level.
candidate_experiencesexperiencesGet employment history and experience details for the candidate.
candidate_attachmentsattachmentsGet attachments such as resumes, cover letters, or certificates uploaded by the candidate.
📘

Use Model IDs for Sync
While invoking sync APIs, pass these Model IDs to retrieve the desired data.

Candidate Info

Model ID: candidate_info

NameTypeDescription
idStringUnique identifier for the candidate in the ATS system
firstNameStringCandidate’s first name
lastNameStringCandidate’s last name
phonesList[Phone]Please refer to Phone Model
emailsList[Email]Please refer to Email Model
linksList[String]List of links such as LinkedIn, portfolio, or personal website
tagsList[String]List of tags associated with the candidate (e.g., “Java”, “Remote”)
titleStringCandidate’s current job title
companyStringCurrent company of the candidate
createdAtDateDate when the candidate record was created
updatedAtDateDate when the candidate record was last updated
applicationsList[String]List of application IDs associated with this candidate

Candidate Education

Model ID: candidate_education

NameTypeDescription
educationList[Education]

Education

NameTypeDescription
idStringUnique identifier for the education record
degreeStringName of the degree obtained
instituteStringName of the educational institution
fromDateDateStart date of the education period
toDateDateEnd date of the education period
majorStringMajor subject of study
minorStringMinor subject of study (if applicable)
descriptionStringAdditional notes or description of the education
scoreStringGrade, GPA, or score achieved
currentlyPursuingBooleanIndicates if the education is still ongoing

Candidate Locations

Model ID: candidate_locations

NameTypeDescription
locationsList[Address]Please refer to Address Model

Candidate Skills

Model ID: candidate_skills

NameTypeDescription
skillsList[Skill]

Skill

NameTypeDescription
nameStringSkill name (e.g., “Python”, “React”)
levelStringSkill proficiency level (e.g., “Expert”, “Beginner”)

Candidate Experiences

Model ID: candidate_experiences

NameTypeDescription
experiencesList[Experience]

Experience

NameTypeDescription
companyStringName of the company
jobTitleStringJob title or role held by the candidate
startDateDateStart date of employment
endDateDateEnd date of employment
currentlyWorkingBooleanIndicates if the candidate is currently working here
summaryStringSummary of responsibilities or achievements in the role

Candidate Attachments

Model ID: candidate_attachments

NameTypeDescription
attachmentsList[Attachment]

Attachment

NameTypeDescription
typeStringRESUME, COVER_LETTER, OFFER_LETTER, NOT_SPECIFIED or as specified in the source app
nameStringName of the file
linkStringPublic or shareable link to the attachment
createdAtDateDate when the attachment was uploaded
attachmentContentStringBase64-encoded attachment content (if applicable)
downloadLinkStringDirect link for downloading the attachment

Example Event Data


{
  "info": {
    "id": "cand_001",
    "firstName": "Alice",
    "lastName": "Johnson",
    "phones": [
      {
        "type": "PERSONAL",
        "phoneNumber": "+1-202-555-0101"
      },
      {
        "type": "WORK",
        "phoneNumber": "+1-202-555-0199"
      }
    ],
    "emails": [
      {
        "type": "PERSONAL",
        "email": "[email protected]"
      },
      {
        "type": "WORK",
        "email": "[email protected]"
      }
    ],
    "links": [
      "https://linkedin.com/in/alicejohnson",
      "https://portfolio.alice.dev"
    ],
    "tags": [
      "Java",
      "Remote",
      "Backend Developer"
    ],
    "title": "Senior Software Engineer",
    "company": "Tech Solutions Ltd.",
    "createdAt": "2022-05-12T09:00:00Z",
    "updatedAt": "2023-08-20T14:00:00Z",
    "applications": [
      "app_12345",
      "app_98765"
    ]
  },
  "education": [
    {
      "id": "edu_101",
      "degree": "Bachelor of Technology",
      "institute": "Delhi Institute of Technology",
      "fromDate": "2015-07-01T00:00:00Z",
      "toDate": "2019-06-30T00:00:00Z",
      "major": "Computer Science",
      "minor": "Mathematics",
      "description": "Graduated with distinction. Led final year AI project.",
      "score": "8.9 CGPA",
      "currentlyPursuing": false
    },
    {
      "id": "edu_102",
      "degree": "Master of Science",
      "institute": "Stanford University",
      "fromDate": "2020-09-01T00:00:00Z",
      "toDate": "2022-06-15T00:00:00Z",
      "major": "Artificial Intelligence",
      "description": "Specialization in Machine Learning.",
      "score": "3.8 GPA",
      "currentlyPursuing": false
    }
  ],
  "locations": [
    {
      "type": "CURRENT",
      "street": "123 Tech Park",
      "city": "Bangalore",
      "state": "Karnataka",
      "country": "India",
      "postalCode": "560103"
    },
    {
      "type": "PERMANENT",
      "street": "45A Oakwood Lane",
      "city": "Delhi",
      "state": "Delhi",
      "country": "India",
      "postalCode": "110001"
    }
  ],
  "skills": [
    {
      "name": "Python",
      "level": "Expert"
    },
    {
      "name": "ReactJS",
      "level": "Intermediate"
    },
    {
      "name": "SQL",
      "level": "Advanced"
    }
  ],
  "experiences": [
    {
      "company": "Tech Solutions Ltd.",
      "jobTitle": "Senior Software Engineer",
      "yearsOfExperience": 3.5,
      "startDate": "2020-02-01T00:00:00Z",
      "endDate": null,
      "currentlyWorking": true,
      "summary": "Leading backend development and API integration for enterprise clients."
    },
    {
      "company": "Innovate Labs",
      "jobTitle": "Software Engineer",
      "yearsOfExperience": 2,
      "startDate": "2018-01-15T00:00:00Z",
      "endDate": "2019-12-31T00:00:00Z",
      "currentlyWorking": false,
      "summary": "Built microservices and internal automation tools."
    }
  ],
  "attachments": [
    {
      "type": "RESUME",
      "name": "Resume_Alice_Johnson.pdf",
      "link": "https://storage.getknit.dev/files/resume-alice.pdf",
      "createdAt": "2023-07-10T09:00:00Z",
      "downloadLink": "https://api.getknit.dev/files/resume-alice.pdf?token=XYZ123"
    },
    {
      "type": "COVER_LETTER",
      "name": "CoverLetter_Alice.pdf",
      "attachmentContent": {
        "content": "c29tZS1iYXNlNjQtZW5jb2RlZC1jb3Zlci1sZXR0ZXItZGF0YQ==",
        "encoding": "BASE64"
      },
      "createdAt": "2023-07-10T09:30:00Z"
    },
    {
      "type": "CERTIFICATE",
      "name": "AWS Certified Developer.pdf",
      "link": "https://storage.getknit.dev/files/aws-cert.pdf",
      "createdAt": "2022-02-15T10:00:00Z",
      "downloadLink": "https://api.getknit.dev/files/aws-cert.pdf?token=ABC789"
    }
  ]
}