Guides
Signup For Free

UKG Ready ATS API Integration

Suggest Edits

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

Delete Job Application

  • ID: delete_job_application
  • Operation: write
  • Entities: company, job application
  • Summary: The Delete Job Application API allows users to delete a specific job application identified by the job_app_id. The request requires two path parameters: 'cid', which is the company identifier, and 'job_app_id', which is the identifier for the job application to be deleted. Upon successful deletion, the API returns a 204 No Content response. If the user is not authorized, a 401 Unauthorized response is returned. A 403 Forbidden response is returned if the user lacks access to the resource. If the specified resource does not exist, a 404 Not Found response is returned. In cases where the call limit is exceeded, a 503 Service Unavailable response is returned, and the application will be unavailable for subsequent calls for the duration specified by the X-CallLimit-TimeToWait header.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Hiring Stages

  • ID: get_hiring_stages
  • Operation: read
  • Entities: hiring stage, workflow, company
  • Summary: The Get Hiring Stages API endpoint is used to fetch a list of all hiring stages within a specified company. The request requires a path parameter 'cid', which is the company identifier. The response includes an array of hiring stages, each with an ID, name, visibility to applicants, and workflow status. The API requires at least one of the HR subsystems and the Recruitment MarketPlace Product. Possible responses include 200 OK, 401 Unauthorized, 403 Forbidden, and 503 Service Unavailable.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Interview Locations

  • ID: get_interview_locations
  • Operation: read
  • Entities: interview location, company
  • Summary: The 'Get Interview Locations' API endpoint is used to fetch a list of interview locations for a specified company. The request requires a path parameter 'cid', which is the company identifier and must be provided in the format of company id, unique id, or short name. The API responds with a list of location names in an array format. The possible HTTP responses include 200 OK for a successful request, 401 Unauthorized if the user is not authorized, 403 Forbidden if the user has no access to the resource, and 503 Service Unavailable if the call limit is exceeded. The response body contains an 'items' array with location names.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Interview Names

  • ID: get_interview_names
  • Operation: read
  • Entities: interview, company
  • Summary: The 'Get Interview Names' API endpoint is used to fetch a list of interview names for a specified company. The request requires a path parameter 'cid', which is the company identifier. The response returns a JSON object containing an array of interview names. The possible HTTP response codes include 200 (OK), 401 (Unauthorized), 403 (Forbidden), and 503 (Service Unavailable). The 503 response includes an 'X-CallLimit-TimeToWait' header indicating the duration for which the application will be unavailable.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Job Application

  • ID: get_job_application
  • Operation: read
  • Entities: hiring stage, company, job application
  • Summary: The Get Job Application API endpoint is used to fetch a specific job application by its job_app_id. It requires two path parameters: 'cid', which is the company identifier, and 'job_app_id', which is the identifier for the job application. The response includes details about the job application such as the account information, applicant comments, application and creation timestamps, hiring stage, job application status, job requisition, and rank. The response also includes a self-link to the job application resource. Possible response codes include 200 (OK), 404 (Not Found), 401 (Unauthorized), 403 (Forbidden), and 503 (Service Unavailable).
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Job Application Status

  • ID: get_job_application_status
  • Operation: read
  • Entities: status, company, job application
  • Summary: The 'Get Job Application Status' API endpoint is used to fetch a list of job application statuses for a specified company. The request requires a path parameter 'cid', which is the company identifier and must be provided in the format of a company id, unique id, or short name. The API returns a list of job application statuses, each with an 'id', 'name', 'sort_order', and 'name_visible_to_applicant'. The possible HTTP responses include 200 OK for a successful request, 401 Unauthorized if the user is not authorized, 403 Forbidden if the user has no access to the resource, and 503 Service Unavailable if the call limit is exceeded.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Job Applications

  • ID: get_job_applications
  • Operation: read
  • Entities: hiring stage, company, job application
  • Summary: The Get Job Applications API endpoint returns a list of all job applications present in a company. It requires a path parameter 'cid' which is the company identifier. The response includes details of each job application such as the applicant's account information, comments, application status, hiring stage, and job requisition details. The response is structured as an array of job application objects, each containing various properties including timestamps for when the application was created and applied. The API returns different HTTP status codes such as 200 for success, 401 for unauthorized access, 403 for forbidden access, and 503 if the service is unavailable due to call limits.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Job Categories

  • ID: get_job_categories
  • Operation: read
  • Entities: cost center job, job category, company
  • Summary: The 'Get Job Categories' API endpoint is used to fetch a list of job categories for a specified company. The request requires a path parameter 'cid', which is the company identifier. The API supports companies using HR or HR (Small Business Edition) subsystems. The response includes an array of job categories, each with a 'name' attribute. The API returns a 200 OK status on success, while 401 Unauthorized, 403 Forbidden, and 503 Service Unavailable are possible error responses.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Job Change Reasons

  • ID: get_job_change_reasons
  • Operation: read
  • Entities: response, company, job change reason
  • Summary: The 'Get Job Change Reasons' API endpoint is used to fetch a list of supported job change reasons for a specified company. The request requires a path parameter 'cid', which is the company identifier. The response includes a list of job change reasons, each with an 'id', 'name', and 'type'. The API returns a 200 OK status on success, while 401 Unauthorized, 403 Forbidden, and 503 Service Unavailable are possible error responses.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Job Requisition Categories

  • ID: get_job_requisition_categories
  • Operation: read
  • Entities: job requisition, job category, company
  • Summary: The 'Get Job Requisition Categories' API endpoint retrieves a list of job categories present in open and active job requisitions within a specified company. The request requires the 'cid' path parameter, which is the company identifier. The response includes an array of job category names. The API requires the HR subsystem and RecruitmentSaaSHR marketplace product within the company. Possible responses include 200 OK, 404 Not Found for invalid EIN Id, 401 Unauthorized for unauthorized access, 403 Forbidden for lack of access, and 503 Service Unavailable if the call limit is exceeded.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Job Requisition Details

  • ID: get_job_requisition_details
  • Operation: read
  • Entities: job requisition, company, location
  • Summary: The Get Job Requisition Details API endpoint retrieves detailed information about a specific job requisition. It requires two path parameters: 'cid', which is the company identifier, and 'id', which is the job requisition ID. The response includes comprehensive details about the job, such as job title, location, compensation, job categories, industries, and contact information. It also provides information about the job's requirements, such as required degree, experience, and employee type. The response is structured in a JSON format, providing a detailed schema of the job requisition.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Job Requisition Locations

  • ID: get_job_requisition_locations
  • Operation: read
  • Entities: job requisition, job location, company
  • Summary: The 'Get Job Requisition Locations' API endpoint retrieves a list of job locations present in open and active job requisitions within a specified company. The API requires the HR subsystem and RecruitmentSaaSHR marketplace product within the company. The request must include the company identifier (cid) as a path parameter, which can be the company id, unique id, or short name. The response includes a list of job locations with their names and translated values. Possible response codes include 200 (OK), 404 (Not Found) for invalid EIN Id, 401 (Unauthorized) for unauthorized users, 403 (Forbidden) for users without access, and 503 (Service Unavailable) if the call limit is exceeded.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Job Requisition Questionnaire Questions

  • ID: get_job_requisition_questionnaire_questions
  • Operation: read
  • Entities: job requisition, company, questionnaire
  • Summary: The 'Get Job Requisition Questionnaire Questions' API endpoint retrieves the questionnaire questions associated with a specific job requisition. This endpoint does not require authentication. It requires two path parameters: 'cid', which is the company identifier and can be a company id, unique id, or short name, and 'id', which is the job requisition id. The response is an array of question objects, each containing details such as the question id, type, text, whether it is required, format, limit, and options for select-type questions. The response schema provides a comprehensive structure of the question attributes, including conditional logic and options for dropdown menus.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Job Requisitions

  • ID: get_job_requisitions
  • Operation: read
  • Entities: job requisition, company, location
  • Summary: The Get Job Requisitions API endpoint returns a list of job requisitions available within a specified company. It requires authentication and the company must be referenced via a company ID, unique ID, or short name in the path parameter 'cid'. The response includes details of each job requisition such as job ID, title, location, job categories, and job classification ID. The response also includes paging information with offset, size, and total number of job requisitions.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Job Status

  • ID: get_job_status
  • Operation: read
  • Entities: status, company, export
  • Summary: The Get Job Status API endpoint is used to retrieve the current status of an export job for a specified company. The API requires two path parameters: 'cid', which is the company identifier, and 'job_id', which is the job identifier. The response includes the job status, result summary, any errors, progress details, and completion time. If the job status is 'DONE', a link to download the file is provided in the Location header. The API returns various HTTP status codes to indicate success or specific errors, such as 401 for unauthorized access, 403 for forbidden access, 404 if the job is not found, and 500 for internal server errors.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Jobs

  • ID: get_jobs
  • Operation: read
  • Entities: job, company
  • Summary: The Get Jobs API endpoint is used to fetch a list of jobs for a specified company. The company is identified by the 'cid' path parameter, which is required and can be a company id, unique id, or short name. The API requires at least one of the following subsystems: TLM, HR, or HR (Small Business Edition). The response includes an array of job objects, each containing an id, name, external_id, payroll_code, and visibility status. The API returns a 200 OK response on success, while 401 Unauthorized, 403 Forbidden, and 503 Service Unavailable responses indicate various error conditions.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Questionnaire

  • ID: get_questionnaire
  • Operation: read
  • Entities: job requisition, benefit enrollment, questionnaire
  • Summary: The Get Questionnaire API endpoint is used to fetch questionnaires related to Job Requisition, Benefit Enrollment, Recruitment Evaluation, or Peer Feedback for a specific company. The request requires a path parameter 'cid', which is the company identifier. The response includes an array of questionnaire items, each with an 'id', 'display_name', and 'description'. The API returns a 200 OK status on success, and may return 404 Not Found if the questionnaire object is not found, 403 Forbidden for security errors, or 400 Bad Request for validation errors.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Reason Codes

  • ID: get_reason_codes
  • Operation: read
  • Entities: timesheet, company, reason code
  • Summary: The Get Reason Codes API returns a list of defined reason codes for a specified company. The request requires the company ID as a path parameter, and the date, owner ID, and type as query parameters. The response includes an array of reason codes, each with an ID and display name.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Termination Reason

  • ID: get_termination_reason
  • Operation: read
  • Entities: termination reason, company
  • Summary: The 'Get Termination Reason' API endpoint is used to fetch a list of termination reasons within a specified company. The request requires a path parameter 'cid', which is the company identifier. The response includes a list of termination reasons, each with an id, display name, code, description, and a boolean indicating if the reason is rehireable. The API returns a 200 OK status on success, while 401 Unauthorized, 403 Forbidden, and 503 Service Unavailable are possible error responses.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Post Job Applications

  • ID: post_job_applications
  • Operation: write
  • Entities: hiring stage, company, job application
  • Summary: The Post Job Applications API endpoint allows for the creation of a new job application. It requires the company ID as a path parameter. The request body must include details such as the account ID, applicant comment, application date, company comment, hiring stage ID, job application status ID, job requisition ID, and rank. The API responds with a 201 Created status if the job application is successfully created. Other possible responses include 401 Unauthorized if the user is not authorized, 403 Forbidden if the user has no access to the resource, and 503 Service Unavailable if the call limit is exceeded.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Put Job Application

  • ID: put_job_application
  • Operation: write
  • Entities: hiring stage, company, job application
  • Summary: The Put Job Application API endpoint allows for replacing an existing job application identified by job_app_id with a new one provided in the payload. The request requires path parameters 'cid' for the company identifier and 'job_app_id' for the job application identifier. The request body can include optional fields such as 'applicant_comment', 'applied_on', 'company_comment', 'hiring_stage', 'job_application_status', and 'rank'. On successful replacement, the API returns a 204 No Content response. Possible error responses include 401 Unauthorized, 403 Forbidden, 404 Not Found, and 503 Service Unavailable.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Updated 5 days ago