Sage Recruitment API Integration

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

Fetch All Applicants for All Recruitment Positions

ID: get_all_job_applications
Operation: read
Entities:
Summary: This configuration fetches all recruitment positions and for each position, retrieves all applicants. The process involves two API calls: first, to list all recruitment positions using the 'List Recruitment Positions' API, and second, for each position ID obtained, to list all applicants using the 'List Applicants for a Position' API. The input requires an authorization token and optional filters for positions. The output is a comprehensive list of positions with their respective applicants, including detailed applicant information such as full name, email, source, and stage details.
Input Fields: Input Fields
Output Fields: Output Fields

ID: get_applicant_actions
Operation: read
Entities: stage, applicant, action
Summary: This API endpoint retrieves a list of actions performed on a specific applicant throughout the recruitment pipeline, ordered from newest to oldest. The request requires the applicant's numeric ID as a path parameter and an authorization token in the headers. Optional query parameters include 'page' for pagination offset and 'per_page' to specify the number of actions returned per call, with a default of 30 and a maximum of 100. The response includes a list of actions with details such as the action type, message, and timestamp, along with pagination metadata.
Input Fields: Input Fields
Output Fields: Output Fields

ID: get_applicant_details
Operation: read
Entities: applicant, position, stage
Summary: The Get Applicant Details API retrieves detailed information about a specific applicant using their numeric ID. The request requires an authorization token in the header and the applicant's ID as a path parameter. The response includes the applicant's full name, email, address, phone number, source, creation date, disqualification date, hiring date, stage details, position ID, and information about who added the applicant and the referrer. The response is returned in JSON format.
Input Fields: Input Fields
Output Fields: Output Fields

ID: get_list_applicants_for_a_position
Operation: read
Entities: applicant, position, stage
Summary: This API endpoint retrieves a list of applicants for a specific position. The request requires an authorization token in the headers and the position ID as a path parameter. Optional query parameters include stage_id for filtering applicants by stage, page for pagination, and per_page to specify the number of applicants returned per call. The response includes a list of applicants with details such as full name, email, source, and stage information, along with pagination metadata.
Input Fields: Input Fields
Output Fields: Output Fields

ID: get_list_recruitment_positions
Operation: read
Entities: recruitment position, hiring manager, location
Summary: The 'List Recruitment Positions' API allows users to retrieve a list of recruitment positions from the Sage HR system. The API supports filtering by various query parameters such as status, hiring manager IDs, group IDs, and location IDs. It also supports pagination through the 'page' and 'per_page' parameters. The request requires an 'X-Auth-Token' header for authorization. The response includes detailed information about each recruitment position, such as its ID, title, status, visibility, creation date, and more. Additionally, metadata about the pagination is provided in the response.
Input Fields: Input Fields
Output Fields: Output Fields

ID: get_position_details
Operation: read
Entities: applicant, hiring team, position
Summary: The Get Position Details API retrieves detailed information about a specific position using its numeric ID. The API requires an authorization token in the header and the position ID as a path parameter. The response includes comprehensive details about the position such as title, status, visibility, creation and completion dates, employment type, location, group, priority, description blocks, applicants, and the hiring team.
Input Fields: Input Fields
Output Fields: Output Fields

ID: post_create_new_applicant
Operation: write
Entities: applicant, position, referral
Summary: This API endpoint allows the creation of a new applicant for a specific position. The position is identified by the path parameter 'id', which must be an open and incomplete position. The request requires an authorization token in the headers. The body of the request should include the applicant's first name, and optionally other details such as last name, email, referral information, phone number, source, address, summary, and an attachment file. The source can be set to predefined keywords or custom values. If a referral object is provided, the source is automatically set to 'referral'. The response will return a 201 status code with the ID of the created applicant if successful, or a 422 status code with validation errors if the request fails.
Input Fields: Input Fields
Output Fields: Output Fields