Guides
Signup For Free

SuccessFactors ATS API Integration

Suggest Edits

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

Add attachment to application

  • ID: add_attachment_to_application
  • Operation: write
  • Entities: Application, Attachment, Candidate
  • Summary: The 'Add attachment to application' API allows users to attach a file to a specific application. The request requires an Authorization header with a Bearer token unless working through knit. The body of the request must include the applicationId, fileName, fileContent, and contentType. Optionally, fileUrl and fileType can be provided. The response returns the status of the operation, including a message and HTTP code.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Add tag to candidate

  • ID: add_tag_to_candidate
  • Operation: write
  • Entities: CandidateTags, Candidate
  • Summary: The 'Add tag to candidate' API allows you to add a specific tag to a candidate by providing the candidate's ID and the tag. The request requires an Authorization header with a Bearer token unless you are working through knit. The request body must include the 'candidateId' and 'tag', both of which are required. The response includes metadata about the created candidate tag resource, including the candidate ID, label of the tag, and the tag ID.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create a new application

  • ID: create_a_new_application
  • Operation: write
  • Entities: JobApplication, 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 candidate note

  • ID: create_candidate_note
  • Operation: write
  • Entities: JobApplicationComments, Note, Application
  • Summary: The Create candidate note API allows users to add a note to a candidate's job application. It requires an Authorization header with a Bearer token for authentication, unless accessed through knit. The request body must include the 'applicationId' and 'note', both of which are required fields. Upon successful creation, the API returns the 'noteId' of the newly created note.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get all attachments for an application

  • ID: get_all_attachments_for_an_application
  • Operation: read
  • Entities: Attachment, Application, Resume
  • Summary: The 'Get all attachments for an application' API retrieves all attachments associated with a specific job application. The API requires an Authorization header with a Bearer token unless accessed through knit. The applicationId is a required path parameter that specifies the job application for which attachments are being retrieved. The response includes details of attachments such as attachmentId, fileName, mimeType, and fileContent in base64 encoding. The response body contains multiple attachments, each with metadata and properties like deletable, viewable, and fileSize. The API provides navigation links to user and candidate entities associated with each attachment.
  • 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: JobApplicationInterview, Application, JobApplication
  • Summary: The 'Get all interview details for an application' API retrieves detailed information about interviews associated with a specific job application. The API requires an Authorization header with a Bearer token unless accessed through knit. The path parameter 'applicationId' is mandatory and specifies the application for which interview details are requested. The response includes metadata about the interview, such as the interview ID, template type, start and end dates, status, and source. It also provides detailed information about the interviewer, including their user ID, display name, email, job title, department, location, and contact details. Deferred links to related resources such as resume, job application, job requisition, interview overall assessment, and interview notes are also included in the response.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get all job applications

  • ID: get_all_job_applications
  • Operation: read
  • Entities: JobApplication
  • Summary: The 'Get all job applications' API retrieves a list of job applications from the specified endpoint. It requires an Authorization header with a Bearer token for authentication, unless accessed through knit. The API supports query parameters such as '$expand' to include related entities, '$top' to limit the number of records, and '$skip' to offset the records. The response includes detailed information about each job application, such as application ID, status, applicant's name, contact details, and deferred URIs for related entities.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get candidate tags

  • ID: get_candidate_tags
  • Operation: read
  • Entities: CandidateTags, Candidate, Tags
  • Summary: The 'Get candidate tags' API retrieves a list of tags associated with a specific candidate identified by the candidateId. The request requires an Authorization header containing a Bearer token unless accessed through knit. The candidateId is a required path parameter. The response includes an array of tags, each with metadata, a unique tagId, label, locale, and deferred candidates information.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get departments for a job

  • ID: get_departments_for_a_job
  • Operation: read
  • Entities: JobRequisition, Department
  • Summary: The 'Get departments for a job' API retrieves detailed information about a specific job requisition, including its associated department details. The API requires an Authorization header with a Bearer token unless accessed through knit. The jobId path parameter is mandatory to specify the job requisition. Optional query parameters can be used to expand related entities. The response includes metadata, job requisition details such as jobReqId, templateType, departmentCode, salary range, location, and more. The department object provides localized names and descriptions in various languages, along with metadata and status information.
  • 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 Requisition
  • Summary: The 'Get details of a specific job' API allows users to retrieve detailed information about a specific job requisition using its job ID. The API requires an Authorization header with a Bearer token unless accessed through knit. The job ID is a required path parameter. Optional query parameters can be used to expand certain entities for more detailed information. The response includes comprehensive details about the job requisition, such as jobReqId, templateType, departmentCode, salary range, location, and various deferred URIs for related entities. The API provides a detailed view of the job requisition, including metadata, status, and other relevant attributes.
  • 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: JobApplication, Candidate
  • Summary: The 'Get details of a specific job application' API retrieves detailed information about a specific job application using the application ID. The API requires an Authorization header with a Bearer token unless accessed through knit. The path parameter 'applicationId' is mandatory to specify the job application to retrieve. Optional query parameters can be used to expand related entities for more detailed information. The response includes metadata and detailed information about the job application, such as application ID, candidate details, status, and contact information.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get hiring managers for a job

  • ID: get_hiring_managers_for_a_job
  • Operation: read
  • Entities: JobRequisition, HiringManager
  • Summary: The 'Get hiring managers for a job' API retrieves information about the hiring managers associated with a specific job requisition. The API requires an Authorization header with a Bearer token unless accessed through knit. The jobId is a required path parameter that specifies the job requisition ID. Optionally, the $expand query parameter can be used to retrieve additional related entities. The response includes detailed information about the job requisition, such as jobReqId, templateType, departmentCode, salary range, location, and more. It also includes a list of hiring managers with details like their names, roles, and contact information.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get offers associated with an application

  • ID: get_offers_associated_with_an_application
  • Operation: read
  • Entities: OfferLetter, Application, Offers
  • Summary: The 'Get offers associated with an application' API retrieves all offer letters associated with a specific job application. The API requires an Authorization header with a Bearer token unless accessed through knit. The path parameter 'applicationId' is mandatory and specifies the application for which offers are being retrieved. The response includes detailed information about each offer, such as the offer letter ID, subject, body content, creation and modification dates, and associated metadata. Deferred navigation properties provide links to related resources such as attachments and job applications.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get offices associated with a job

  • ID: get_offices_associated_with_a_job
  • Operation: read
  • Entities: JobRequisition, Location, Offices
  • Summary: The 'Get offices associated with a job' API retrieves detailed information about a specific job requisition, including associated offices and other related entities. The API requires an Authorization header with a Bearer token for authentication. The jobId is a required path parameter that specifies the job requisition to retrieve. Optional query parameters can be used to expand related entities for more detailed information. The response includes a comprehensive set of data about the job requisition, such as jobReqId, departmentCode, salary details, location information, and various deferred URIs for related entities. This API is useful for obtaining detailed job requisition data, including associated offices and other related entities, in a structured format.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get recruiters assigned to a job

  • ID: get_recruiters_assigned_to_a_job
  • Operation: read
  • Entities: JobRequisition, JobRequisitionOperator, Recruiter
  • Summary: The 'Get recruiters assigned to a job' API retrieves detailed information about a specific job requisition, including the recruiters assigned to it. The API requires an Authorization header with a Bearer token for authentication. The jobId path parameter is mandatory to specify the job requisition. Optional query parameters can be used to expand related entities. The response includes metadata about the job requisition, such as jobReqId, templateType, departmentCode, salary details, location, and more. It also provides a list of recruiters assigned to the job, with details like their names, roles, and contact information.
  • 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: JobApplication, JobApplicationStatus, CurrentStage
  • Summary: The 'Get the current stage of an application' API retrieves the current status and details of a job application using the application ID. The API requires an Authorization header with a Bearer token unless accessed through knit. The application ID is a required path parameter. Optional query parameters can be used to expand related entities. The response includes metadata, application ID, status, applicant's name, contact details, country, job requisition ID, and job application status details.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List all jobs

  • ID: list_all_jobs
  • Operation: read
  • Entities: Job Requisition
  • Summary: The 'List all jobs' API retrieves a list of job requisitions from the specified endpoint. It requires an Authorization header with a Bearer token for authentication. The API supports optional query parameters such as '$skip' to skip a specified number of records and '$expand' to include additional related entities in the response. The response includes detailed information about each job requisition, including metadata, job requisition ID, template type, creation date, job code, number of openings, default language, currency, and various deferred URIs for related entities. The API is useful for retrieving comprehensive job requisition data for further processing or analysis.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Application Stage

  • ID: update_application_stage
  • Operation: write
  • Entities: Application, ApplicationStage
  • Summary: The Update Application Stage API allows you to update the stage of a specific application by providing the application ID and the target stage ID. The request requires an Authorization header with a Bearer token unless you are working through knit. The response includes the status of the update operation, a message, and the HTTP status code.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Updated about 1 month ago