Guides
Signup For Free

iCIMS API Integration

Suggest Edits

These are the list of integration use cases supported by Knit for iCIMS API as part of the ATS category

Add tag to candidate

  • ID: add_tag_to_candidate
  • Operation: write
  • Entities: Candidate, Tags
  • Summary: The 'Add tag to candidate' API allows you to add a specific tag to a candidate identified by their candidate ID. The request requires an Authorization header with a Bearer token unless you are working through knit. The path parameter 'candidateId' is required to specify the candidate, and the body must include the 'tagId' of the tag to be added. The response returns the candidate ID and a list of tags associated with the candidate, including the newly added tag.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create a new application

  • ID: create_a_new_application
  • Operation: write
  • Entities: Application, Candidate, Job
  • Summary: The 'Create a new application' API allows users to create a new job application by providing candidate details and job ID. The request requires an Authorization header unless working through knit. The body can include candidate details such as first name, last name, phone numbers, and emails, or a candidateId if the candidate is already known. The jobId is mandatory. Metadata such as country is also required unless candidateId is provided. The response includes the applicationId, candidateId, and jobId of the created application.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create job

  • ID: create_job
  • Operation: write
  • Entities: Job
  • Summary: The Create job API allows users to create a new job entry in the system. It requires an Authorization header with a Bearer token unless working through knit. The request body must include details such as the folder (with id and value), job title, job location ID, hiring manager ID, and job owner ID. Upon successful creation, the API returns the job ID of the newly created job.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get all attachments for an application

  • ID: get_all_attachments_for_an_application
  • Operation: read
  • Entities: Application, Candidate, Attachment, Resume
  • Summary: This API retrieves all attachments for a specific application. It requires an Authorization header with a Bearer token unless accessed through knit. The path parameter 'applicationId' is required to specify the application for which attachments are being retrieved. The response includes details about the attached file, such as its name, base64 encoded content, type, and associated application and candidate IDs.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get all interview details for an application

  • ID: get_all_interview_details_for_an_application
  • Operation: read
  • Entities: Application, interview
  • Summary: This API retrieves all interview details for a specific application. It requires the application ID as a path parameter and an Authorization header with a Bearer token unless you are working through knit. The response includes the application ID and details of the interview, such as its status and scheduled date.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get all job applications

  • ID: get_all_job_applications
  • Operation: read
  • Entities: Application
  • Summary: The 'Get all job applications' API retrieves a list of job application workflows for a specified customer. The API requires an Authorization header with a Bearer token unless accessed through knit. The request can include a body with filters for pagination, such as filtering by 'applicantworkflow.person.id'. The response includes a list of search results, each containing a URL to the specific applicant workflow and its ID.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get candidate tags

  • ID: get_candidate_tags
  • Operation: read
  • Entities: candidate, Tags
  • Summary: The Get candidate tags API retrieves the tags associated with a specific candidate. The request requires the candidate's unique identifier as a path parameter and an Authorization header containing a Bearer token, unless working through knit. The response includes the candidate's ID and a list of tags, each with a unique ID and value.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get departments for a job

  • ID: get_departments_for_a_job
  • Operation: read
  • Entities: Job, Department
  • Summary: The 'Get departments for a job' API retrieves the department details for a specified job ID. The request requires an Authorization header with a Bearer token unless you are working through knit. The jobId is a required path parameter. The response includes the jobId and the department details, which consist of the department ID and name.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get details of a specific job

  • ID: get_details_of_a_specific_job
  • Operation: read
  • Entities: Job, Department, Location, HiringManager, Recruiter
  • Summary: The 'Get details of a specific job' API retrieves detailed information about a specific job using the job's unique identifier. The request requires an Authorization header with a Bearer token unless accessed through knit. The path parameter 'jobId' is mandatory to specify the job. The response includes details such as the job title, overview, due date, department, location, hiring manager, and recruiter.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get details of a specific job application

  • ID: get_details_of_a_specific_job_application
  • Operation: read
  • Entities: Application, ApplicationStage
  • Summary: This API retrieves the details of a specific job application using the application ID. It requires an Authorization header with a Bearer token unless accessed through knit. The path parameter 'applicationId' is required to specify the job application. The response includes detailed information about the job and candidate profiles, application status, source, and video interview details.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get hiring managers for a job

  • ID: get_hiring_managers_for_a_job
  • Operation: read
  • Entities: Job, HiringManager
  • Summary: This API retrieves the hiring managers for a specific job. It requires the job ID as a path parameter and an Authorization header containing a Bearer token, unless you are working through knit. The response includes the job ID and details of the hiring manager, such as their ID and email address.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get offices associated with a job

  • ID: get_offices_associated_with_a_job
  • Operation: read
  • Entities: Job, Location
  • Summary: This API retrieves the offices associated with a specific job. It requires the job ID as a path parameter and an Authorization header with a Bearer token unless you are working through knit. The response includes the job ID and the location details, such as the location ID and name.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get recruiters assigned to a job

  • ID: get_recruiters_assigned_to_a_job
  • Operation: read
  • Entities: Job, Recruiter
  • Summary: This API retrieves the recruiters assigned to a specific job. It requires the job ID as a path parameter and an Authorization header containing a Bearer token, unless you are working through knit. The response includes the job ID and details of the recruiter assigned to the job, such as their ID and email.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get the current stage of an application

  • ID: get_the_current_stage_of_an_application
  • Operation: read
  • Entities: Application, ApplicationStage
  • Summary: This API retrieves the current stage of a specific application. It requires the application ID as a path parameter and an Authorization header containing a Bearer token, unless you are working through knit. The response includes the application ID and an object representing the current stage, which contains the stage ID and stage name.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List all jobs

  • ID: list_all_jobs
  • Operation: read
  • Entities: Jobs, Job
  • Summary: The 'List all jobs' API allows users to retrieve a list of job postings from the iCIMS platform. The API requires an Authorization header with a Bearer token unless accessed through knit. The request can include a body with filters for pagination, specifying conditions such as 'applicantworkflow.person.id' with a value and operator. The response includes a list of job search results, each with a URL and job ID.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Application Stage

  • ID: update_application_stage
  • Operation: write
  • Entities: Application, Stage
  • Summary: The Update Application Stage API allows you to update the stage of an application in the iCIMS system. You must provide the application ID as a path parameter and the new stage ID in the request body. The Authorization header is required unless you are working through knit. The API returns the application ID of the updated application in the response body.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Updated 5 days ago