ADP WorkForceNow ATS API Integration

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

Retrieve All Job Applications

ID: get_all_job_applications
Operation: read
Entities: application, job, applicant
Summary: This API retrieves the list of all available job applications that the requester is authorized to view. It requires the 'roleCode' header to specify the role of the user, and optionally an 'Authorization' header for OAuth 2.0 token. The API supports OData query parameters such as '$select', '$expand', and '$filter' to refine the results. The response includes detailed information about each job application, including job requisition references, application status, application source, applicant details, applied locations, and attachments. The response headers include 'Cache-Control', 'ETag', and 'Content-Type'.
Input Fields: Input Fields
Output Fields: Output Fields

ID: get_job_requisition_information
Operation: read
Entities: job, location, department
Summary: This API retrieves information about a specific job requisition using the job requisition ID. The request requires an OAuth 2.0 Bearer token for authentication and must specify the job requisition ID in the path parameters. The response includes detailed information about the job requisition, such as posting instructions, company details, job title, hiring manager, and more. The response is returned in JSON format.
Input Fields: Input Fields
Output Fields: Output Fields

ID: get_list_of_job_requisitions
Operation: read
Entities: job, location, department
Summary: This API retrieves a list of job requisitions that the requester is authorized to view. It uses the GET method and requires OAuth 2.0 authentication with a bearer token. The API endpoint is '/staffing/v1/job-requisitions'. The request can include optional query parameters such as '$filter', '$skip', and '$top' to filter, paginate, and limit the number of job requisitions returned. The response includes a list of job requisitions with details such as item ID, posting instructions, links, supported locale codes, visibility indicators, company name, openings quantity, requisition locations, client requisition ID, requisition status code, and job details. The response also includes metadata with the total number of job requisitions.
Input Fields: Input Fields
Output Fields: Output Fields

ID: get_specific_job_application
Operation: read
Entities: application, job, applicant
Summary: This API retrieves a specific job application using the job application ID. It requires the roleCode and Authorization headers, where roleCode specifies the role of the user (e.g., employee, manager) and Authorization provides the OAuth 2.0 token. The job-application-id is a required path parameter. An optional $expand query parameter can be used to specify expansion criteria. The response includes detailed information about the job application, such as job requisition reference, application status, applicant details, comments, applied locations, requested pay rate, and attachments. The response headers include Cache-Control, ETag, and Content-Type.
Input Fields: Input Fields
Output Fields: Output Fields

ID: post_change_applicant_external_assessment_status
Operation: write
Entities: application, status, user
Summary: This API changes the external assessment status of a job applicant. It requires an OAuth 2.0 token for authentication and accepts requests in JSON format. The request body must include the agency code, application ID, assessment status code, and assessment package ID. The response includes the updated status of the job applications. If any required fields are missing, the API returns a 400 Bad Request error with a descriptive message.
Input Fields: Input Fields
Output Fields: Output Fields