How to get the list of Jobs

There are two ways to fetch the list of jobs from your integrations:

1. Syncs (Webhook-based Bulk Reads)

Syncs provide an automated, push-based approach for bulk data retrieval. Once you set up a sync for an integration, Knit polls the source app for changes and sends updates straight to your webhook. This webhook-based model eliminates the need for you to continuously pull data.

Read more about syncs and webhooks here: https://developers.getknit.dev/docs/register-webhook-url#/

2. Read APIs (On-demand Individual Reads)

Read APIs provide on-demand access to specific data through request-response calls. These are standard GET/List operations that allow you to retrieve job information whenever needed.

You can refer to applicant tracking systems APIs here: https://developers.getknit.dev/reference/list-jobs#/

Data Model

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

Model ID	Event Data Key	Description
`job_info`	`info`	Get the data of a job like id, title, createdAt, status, url etc
`job_departments`	`departments`	Get information about departments which the job belongs to
`job_offices`	`offices`	Get information about the offices which the job belongs to
`job_hiringManagers`	`hiringManagers`	Get information about the hiring managers of the job
`job_recruiters`	`recruiters`	Get the recruiters associated with the job
`job_stages`	`stages`	Get information about all the stages associated with the job
`job_rawValues`	`rawValues`	Get information raw values of status, descriptions associated with job.
`job_posts`	`jobPosts`	Get the List of Job Posts associated with the job.
`job_compensation`	`jobCompensation`	Get compensation details for the job including salary, equity, benefits, and bonuses.
`job_questions`	`jobQuestions`	Get the list of questions associated with the job application.
`job_requirements`	`jobRequirements`	Get the requirements for the job including skills, certifications, education, experience, and languages.
`job_info_enhanced`	`jobInfoEnhanced`	Get enhanced job information including employment type, work arrangement, experience level, and descriptions.

All these models have been detailed out below for your reference.

📘
Use Model IDs for Sync
While invoking sync APIs, pass these model IDs in order to get the desired data.

User

Name	Type	Description
`id`	`String`	User ID in the ATS system
`email`	`String`
`employeeId`	`String`	Employee ID of the user

Job Info

Model ID: job_info

Name	Type	Description
`id`	`String`	Unique identifier for the job
`title`	`String`	Job title/position name
`description`	`String`	Detailed description of the job responsibilities and requirements
`createdAt`	`Date`	Date when the job was created
`updatedAt`	`Date`	Date when the job was last updated
`closedAt`	`Date`	Date when the job was closed (if applicable)
`status`	`Enum`	Current status of the job. One of: `OPEN` `CLOSED` `DRAFT` `NOT_SPECIFIED`
`confidential`	`Boolean`	Indicates whether the job is confidentialor not
`jobCodes`	`List[String]`	Internal reference codes used by the hiring organization
`infoUrl`	`String`	URL for viewing the full job description
`applyUrl`	`String`	URL for submitting an application to this job

Job Departments

Model ID: job_departments

Name	Type	Description
`departments`	`List[Department]`	Departments associated with the job

Department

Name	Type	Description
`id`	`String`	ID provided by the ATS
`name`	`String`

Job Offices

Model ID: job_offices

Name	Type	Description
`offices`	`List[Office]`	Offices associated with the job

Office

Name	Type	Description
`id`	`String`	ID provided by the ATS
`name`	`String`
`location`	`String`
`address`	`Address`	Please refer to https://developers.getknit.dev/reference/base-models#address

Job Hiring Managers

Model ID: job_hiringManagers

Name	Type	Description
`hiringManagers`	`List[User]`	Hiring Managers associated with the job

Job Recruiters

Model ID: job_recruiters

Name	Type	Description
`recruiters`	`List[User]`	Recruiters associated with the job

Job Stages

Model ID: job_stages

Name	Type	Description
`stages`	`List[Stage]`

Stage

Name	Type	Description
`id`	`String`	Stage Id
`text`	`String`	Stage Name

Job Raw values

Model ID: job_rawValues

Name	Type	Description
`jobInfo`	`Job Info Raw Values`	Raw values associated with Job Info model.

Job Info Raw Values

Name	Type	Description
`status`	`String`
`descriptions`	`List[Description]`

Description

Name	Type	Description
`id`	`String`	Job Description Id
`description`	`String`	Job Description Text

Job Posts

Model ID: job_posts

Name	Type	Description
`jobPosts`	`List[JobPost]`	List of job posts associated with the job

JobPost

Name	Type	Description
`id`	`String`	Job post ID
`jobId`	`String`	ID of the job this post belongs to
`title`	`String`	Title of the job post
`description`	`String`	Description of the job post
`status`	`Enum`	Status of the job post. One of: `DRAFT` `PUBLISHED` `PAUSED` `EXPIRED` `ARCHIVED` `DELETED` `ON_HOLD` or as specified in the source app
`urls`	`List[JobPostURL]`	URLs associated with this job post
`platform`	`Enum`	Platform where the job is posted. One of: `LINKEDIN` `INDEED` `GLASSDOOR` `COMPANY_WEBSITE` or as specified in the source app
`publishedAt`	`Date`	When the job was published
`expiresAt`	`Date`	When the job post expires
`createdAt`	`Date`	When the job post was created
`updatedAt`	`Date`	When the job post was last updated

JobPostURL

Name	Type	Description
`type`	`Enum`	Type of URL. One of: `PERSONAL` `COMPANY` `PORTFOLIO` `BLOG` `SOCIAL_MEDIA` `JOB_POSTING` `NOT_SPECIFIED`
`url`	`String`	The URL

Job Compensation

Model ID: job_compensation

Name	Type	Description
`salary`	`JobCompensationSalary`	Salary information
`equity`	`JobCompensationEquity`	Equity information
`benefits`	`List[JobCompensationBenefit]`	List of benefits
`bonuses`	`List[JobCompensationBonus]`	List of bonuses

JobCompensationSalary

Name	Type	Description
`currency`	`String`	Currency code (e.g., USD, EUR)
`period`	`Enum`	Payment frequency. One of: `ANNUAL` `HALF_YEARLY` `WEEKLY` `QUARTERLY` `SEMI_MONTHLY` `MONTHLY` `HOURLY` `BI_WEEKLY` `DAILY` `ONE_TIME` `FOUR_WEEKLY` or as specified in the source app
`minAmount`	`Double`	Minimum salary amount
`maxAmount`	`Double`	Maximum salary amount
`negotiable`	`Boolean`	Whether salary is negotiable
`public`	`Boolean`	Whether salary is publicly visible

JobCompensationEquity

Name	Type	Description
`offered`	`Boolean`	Whether equity is offered
`percentage`	`Double`	Percentage of equity offered
`description`	`String`	Description of equity package

JobCompensationBenefit

Name	Type	Description
`name`	`String`	Name of the benefit
`category`	`String`	Category of the benefit

JobCompensationBonus

Name	Type	Description
`type`	`Enum`	Type of bonus. One of: `PERFORMANCE` `SIGNING` `ANNUAL` `QUARTERLY` `OTHER` or as specified in the source app
`amount`	`Double`	Bonus amount
`description`	`String`	Bonus description
`currency`	`String`	Currency code (e.g., USD, EUR)

Job Requirements

Model ID: job_requirements

Name	Type	Description
`skills`	`List[Skill]`	List of required skills
`certifications`	`List[Certification]`	List of required certifications
`education`	`Education`	Education requirements
`experience`	`Experience`	Experience requirements
`languages`	`List[JobRequirementLanguage]`	List of language requirements

Skill

Name	Type	Description
`id`	`String`	Skill ID
`name`	`String`	Name of the skill
`category`	`Enum`	Skill category. One of: `TECHNICAL` `SOFT` `LANGUAGE` `TOOL` `FRAMEWORK` `OTHER`
`proficiencyLevel`	`Enum`	Required proficiency level. One of: `BEGINNER` `INTERMEDIATE` `ADVANCED` `EXPERT` `NOT_SPECIFIED`
`yearsOfExperience`	`Double`	Required years of experience
`required`	`Boolean`	Is the Skill Required
`preferred`	`Boolean`	Is the Skill Preferred

Certification

Name	Type	Description
`id`	`String`	Certification ID
`name`	`String`	Name of the certification
`category`	`Enum`	Certification category. One of: `CLOUD` `PROJECT_MANAGEMENT` `SECURITY` `FINANCE` `HEALTHCARE` `OTHER`
`issuingOrganization`	`String`	Organization that issued the certification
`expirable`	`Boolean`	Whether the certification expires
`required`	`Boolean`	Is the Certification Required
`preferred`	`Boolean`	Is the Certification Preferred

Education

Name	Type	Description
`minimumDegree`	`Enum`	Minimum required education degree. One of: `HIGH_SCHOOL` `BACHELORS` `MASTERS` `DOCTORATE` `DIPLOMA` `ASSOCIATE` `POSTDOCTORATE` `VOCATIONAL` `NOT_REQUIRED` or as specified in the source app
`fieldOfStudy`	`List[String]`	List of relevant fields of study
`required`	`Boolean`	Whether the education is required

Experience

Name	Type	Description
`minimumYears`	`Double`	Minimum years of experience required
`preferredYears`	`Double`	Preferred years of experience

JobRequirementLanguage

Name	Type	Description
`language`	`String`	Required language
`proficiency`	`Enum`	Required proficiency level. One of: `BASIC` `CONVERSATIONAL` `FLUENT` `NATIVE`
`required`	`Boolean`	Whether the language is required

Job Questions

Model ID: job_questions

Name	Type	Description
`questions`	`List[JobQuestion]`	List of job application questions

JobQuestion

Name	Type	Description
`id`	`String`	Question ID
`title`	`String`	Question title
`description`	`String`	Detailed description of the question
`type`	`Enum`	Question type. One of: `TEXT` `SINGLE_CHOICE` `MULTIPLE_CHOICE` `YES_NO` `NUMBER` `DATE` `FILE_UPLOAD` `DROPDOWN` `RATING_SCALE` or as specified in the source app
`required`	`Boolean`	Whether the question is mandatory
`options`	`List[Option]`	Available options for choice-based questions
`category`	`Enum`	Question category. One of: `BASIC_INFO` `EXPERIENCE` `AVAILABILITY` `LEGAL` `CUSTOM` `SCREENING` or as specified in the source app
`createdAt`	`Date`	When the question was created
`updatedAt`	`Date`	When the question was last updated

Option

Name	Type	Description
`id`	`String`	Option ID
`text`	`String`	Option text

Job Info Enhanced

Model ID: job_info_enhanced

Name	Type	Description
`employmentType`	`Enum`	Type of employment. One of: `FULL_TIME` `CONTRACT` `PART_TIME` `TEMPORARY` `FREELANCE` or as specified in the source app
`workArrangement`	`Enum`	Work arrangement type. One of: `REMOTE` `ON_SITE` `HYBRID` or as specified in the source app
`experienceLevel`	`Enum`	Required experience level. One of: `ENTRY` `MID` `SENIOR` `EXECUTIVE` or as specified in the source app
`applicationDeadline`	`Date`	Deadline for job applications
`expectedStartDate`	`Date`	Expected start date for the position
`descriptions`	`List[Description]`	Additional descriptions about the job

Description

Name	Type	Description
`type`	`Enum`	Description format type. One of: `HTML_CONTENT` `PLAIN_TEXT`
`value`	`String`	The description content

Event Data Example

{
  "info": {
    "id": "CqrN2sN5U89GaYO",
    "title": "SDE 1",
    "description": "Junior Developer Backend",
    "createdAt": "1970-01-01T00:00:00Z",
    "updatedAt": "1970-01-01T00:00:00Z",
    "closedAt": "1970-01-01T00:00:00Z",
    "status": "OPEN",
    "confidential": false,
    "jobCodes": [
      "7MBL9rEloOSbq1R",
      "85LY1duVrbHYMk3"
    ],
    "infoUrl": "www.linktoJob.com",
    "applyUrl": "www.linktoJob.com/apply"
  },
  "departments": [
    {
      "id": "CLtvELzXE1XzhaP",
      "name": "Backend"
    },
    {
      "id": "IDGpZLpmuNnJ8bG",
      "name": "Engineering"
    }
  ],
  "offices": [
    {
      "id": "AZ9Gl6M2IDZhrkw",
      "name": "HQ",
      "location": "Delhi, India",
      "address": {
        "addressLine1": "Clockhouse Place",
        "addressLine2": "Bedfont Road",
        "city": "Delhi",
        "state": "Delhi",
        "country": "India",
        "zipCode": "110044",
        "addressType": "NOT_SPECIFIED"
      }
    }
  ],
  "hiringManagers": [
    {
      "id": "Gis4YYXT3CugIRZ",
      "email": "hr@org.com",
      "employeeId": "WWbJ35lotScHzpz"
    },
    {
      "id": "bF6uNyYrQU0n4QK",
      "email": "vphr@org.com",
      "employeeId": "vGeFgYQkMKPTE9a"
    }
  ],
  "recruiters": [
    {
      "id": "Gis4YYXT3CugIRZ",
      "email": "recruiter@org.com",
      "employeeId": "WWbJ35lotScHzpz"
    }
  ],
  "stages": [
    {
      "id": "Q1do2hbFuBg2nrw",
      "text": "Phone Screen"
    },
    {
      "id": "IwwMkX3EkFfse",
      "text": "Technical Test"
    },
    {
      "id": "T3kfAZiN7Mgrs5",
      "text": "Technical Screen"
    },
    {
      "id": "8zTpCce7hkfde3",
      "text": "Culture Fit"
    }
  ],
  "rawValues": {
    "jobInfo": {
      "status": "open",
      "descriptions": [
        {
          "id": "123",
          "description": "Job Description in Short"
        },
        {
          "id": "124",
          "description": "Job Description in Detail"
        }
      ]
    }
  },
  "jobPosts": [
    {
      "id": "job_post_12345",
      "jobId": "CqrN2sN5U89GaYO",
      "title": "Senior Software Engineer",
      "description": "We're looking for an experienced software engineer to join our team...",
      "status": "PUBLISHED",
      "urls": [
        {
          "type": "JOB_POSTING",
          "url": "https://company.com/careers/senior-software-engineer"
        },
        {
          "type": "COMPANY",
          "url": "https://company.com"
        },
        {
          "type": "SOCIAL_MEDIA",
          "url": "https://linkedin.com/company/example/jobs/123"
        }
      ],
      "platform": "LINKEDIN",
      "publishedAt": "2023-05-15T09:00:00Z",
      "expiresAt": "2023-06-30T23:59:59Z",
      "createdAt": "2023-05-10T14:30:00Z",
      "updatedAt": "2023-05-12T11:15:00Z"
    }
  ],
  "jobCompensation": {
    "salary": {
      "currency": "USD",
      "period": "ANNUAL",
      "minAmount": 100000,
      "maxAmount": 150000,
      "negotiable": true,
      "public": false
    },
    "equity": {
      "offered": true,
      "percentage": 0.5,
      "description": "Vested over 4 years with 1-year cliff"
    },
    "benefits": [
      {
        "name": "Health Insurance",
        "category": "HEALTHCARE"
      },
      {
        "name": "401(k) Matching",
        "category": "RETIREMENT"
      },
      {
        "name": "Unlimited PTO",
        "category": "TIME_OFF"
      }
    ],
    "bonuses": [
      {
        "type": "SIGNING",
        "amount": 10000,
        "description": "One-time signing bonus",
        "currency": "USD"
      },
      {
        "type": "PERFORMANCE",
        "amount": 20000,
        "description": "Annual performance bonus (target)",
        "currency": "USD"
      }
    ]
  },
  "jobQuestions": [
    {
      "id": "question_12345",
      "title": "Years of experience",
      "description": "How many years of professional experience do you have?",
      "type": "NUMBER",
      "required": true,
      "options": null,
      "category": "EXPERIENCE",
      "createdAt": "2023-05-15T09:00:00Z",
      "updatedAt": "2023-05-20T14:30:00Z"
    },
    {
      "id": "question_22222",
      "title": "Highest education level",
      "type": "DROPDOWN",
      "required": true,
      "options": [
        {
          "id": "opt_4",
          "text": "High School"
        },
        {
          "id": "opt_5",
          "text": "Bachelor's Degree"
        },
        {
          "id": "opt_6",
          "text": "Master's Degree"
        },
        {
          "id": "opt_7",
          "text": "PhD"
        }
      ],
      "category": "BASIC_INFO"
    }
  ],
  "jobRequirements": {
    "skills": [
      {
        "id": "skill_123",
        "name": "Java",
        "category": "TECHNICAL",
        "proficiencyLevel": "ADVANCED",
        "yearsOfExperience": 5,
        "required": true,
        "preferred": true
      },
      {
        "id": "skill_456",
        "name": "Project Management",
        "category": "SOFT",
        "proficiencyLevel": "INTERMEDIATE",
        "yearsOfExperience": 3,
        "required": true,
        "preferred": true
      }
    ],
    "certifications": [
      {
        "id": "cert_789",
        "name": "AWS Certified Solutions Architect",
        "category": "CLOUD",
        "issuingOrganization": "Amazon Web Services",
        "expirable": true,
        "required": true,
        "preferred": true
      },
      {
        "id": "cert_101",
        "name": "PMP",
        "category": "PROJECT_MANAGEMENT",
        "issuingOrganization": "PMI",
        "expirable": true,
        "required": true,
        "preferred": true
      }
    ],
    "education": {
      "minimumDegree": "BACHELORS",
      "fieldOfStudy": [
        "Computer Science",
        "Information Technology"
      ],
      "required": true
    },
    "experience": {
      "minimumYears": 3,
      "preferredYears": 5
    },
    "languages": [
      {
        "language": "English",
        "proficiency": "FLUENT",
        "required": true
      },
      {
        "language": "Spanish",
        "proficiency": "CONVERSATIONAL",
        "required": false
      }
    ]
  },
  "jobInfoEnhanced": {
    "employmentType": "FULL_TIME",
    "workArrangement": "HYBRID",
    "experienceLevel": "MID",
    "applicationDeadline": "2024-12-31T00:00:00Z",
    "expectedStartDate": "2025-01-15T00:00:00Z",
    "descriptions": [
      {
        "type": "HTML_CONTENT",
        "value": "<h1>Job Description</h1><p>We are looking for a skilled developer...</p>"
      },
      {
        "type": "PLAIN_TEXT",
        "value": "Requirements: 3+ years of experience, Bachelor's degree"
      }
    ]
  }
}