Guides
Signup For Free

SmartRecruiters ATS API Integration Vol.1

Suggest Edits

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

Create a New Candidate and Assign to a Job

  • ID: create_a_new_application
  • Operation: write
  • Entities:
  • Summary: This API endpoint allows you to create a new candidate and assign them to a specific job using the job ID. It is crucial to track the candidate's source accurately by including the sourceDetails object in the request body. The request requires the candidate's first name, last name, and email, and optionally includes additional details such as phone number, location, web profiles, tags, education, experience, and source details. The response returns the created candidate's details, including their ID, name, contact information, location, web profiles, education, experience, and job assignments. The API also handles various error responses for invalid source details, permission issues, and non-existent source types.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Share Message with Users and Teams

  • ID: create_candidate_note
  • Operation: write
  • Entities:
  • Summary: This API endpoint allows users to share messages with specific users, hiring teams, or everyone in a company. The request body requires a 'content' field for the message text, and optional fields such as 'correlationId' for additional ID reference, and 'shareWith' for specifying visibility options. The 'shareWith' object can include 'users' (an array of user IDs), 'hiringTeamOf' (an array of job IDs), 'everyone' (a boolean to share with all company members), and 'openNote' (a boolean to share with those having access to tagged candidates). The response returns a 201 status with an 'id' and 'shareRequired' flag if successful, or a 400 status with error codes for various issues such as invalid visibility options or non-existent users.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Candidate

  • ID: delete_candidate
  • Operation: write
  • Entities: candidate
  • Summary: The Delete Candidate API allows you to delete a candidate from the system using their unique identifier. The API requires the candidate's ID as a path parameter. The request should include an 'accept' header specifying 'application/json'. A successful deletion returns a 204 status code with no content. If the candidate access is denied, a 403 status code is returned with a JSON body containing error details. If the candidate is not found, a 404 status code is returned with a JSON body containing error details.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Candidate Attachment

  • ID: delete_candidate_attachment
  • Operation: write
  • Entities: candidate, attachment
  • Summary: This API endpoint is used to delete a candidate's attachment by its identifier. The DELETE method is used, and the endpoint requires the 'attachmentId' as a path parameter. The request should include an 'accept' header with 'application/json' as the value. If the deletion is successful, a 204 status code is returned with no content. If the user does not have permission to delete the attachment, a 403 status code is returned with a message and error details. If the attachment does not exist, a 404 status code is returned with a message and error details.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Remove Candidate Property Value Label

  • ID: delete_candidate_property_value_label
  • Operation: delete
  • Entities: candidate property value, candidate property
  • Summary: This API endpoint is used to remove a candidate property value label. It requires the candidate property identifier 'id' and the candidate property's value identifier 'valueId' as path parameters. The request does not require a body or query parameters. The response can be a 204 No Content if successful, a 400 Bad Request with specific error codes if there are issues with the request, or a 404 Not Found if the specified candidate property or value does not exist.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Candidate Tags

  • ID: delete_candidate_tags
  • Operation: write
  • Entities: tag, candidate
  • Summary: This API endpoint deletes all tags associated with a given candidate. The request requires the candidate's identifier as a path parameter. The DELETE method is used, and the request should include an 'accept' header specifying 'application/json'. If successful, a 204 status code is returned indicating that the candidate's tags have been successfully deleted. If the user does not have permission to access the candidate, a 403 status code is returned with a JSON response containing an error message and details.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Candidate's Application to a Job

  • ID: delete_candidates_application_to_a_job
  • Operation: write
  • Entities: candidate, job, application
  • Summary: This API endpoint allows the deletion of a candidate's application to a specific job. It requires the candidate identifier and job identifier as path parameters. The request does not require a body or specific headers, but it can accept 'application/json' as a response format. Upon successful deletion, a 204 status code is returned. If the user does not have permission, a 403 status code is returned with a message and error details. If the application is not found, a 404 status code is returned with a message and error details.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Company Integration

  • ID: delete_company_integration
  • Operation: write
  • Entities: company, integration
  • Summary: The Delete Company Integration API allows you to remove an integration for a specific company identified by the companyId path parameter. The request requires the companyId as a path parameter and accepts an optional 'accept' header to specify the media type for the response. The API responds with a 204 No Content status, indicating that the operation was successful and no content is returned in the response body.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Deactivate Job Property

  • ID: delete_deactivate_job_property
  • Operation: write
  • Entities: job property
  • Summary: This API endpoint deactivates a job property identified by the 'id' path parameter. It requires the 'id' of the job property to be specified in the URL path. The request does not require a body or additional query parameters. The response can be a 204 status code indicating success with no content, a 403 status code indicating forbidden access due to authorization issues, or a 404 status code indicating that the job property was not found. The 403 and 404 responses include a JSON body with a message and an array of errors, each containing a code and message.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Deactivate User Account

  • ID: delete_deactivate_user_account
  • Operation: write
  • Entities: user
  • Summary: This API endpoint is used to deactivate a user account in the SmartRecruiters system. The request requires the user identifier as a path parameter. The DELETE method is used to perform the deactivation. The request header can optionally include 'accept: application/json' to specify the response format. If the operation is successful, a 204 status code is returned indicating the user has been successfully deactivated. If the user is not permitted to manage users, a 403 status code is returned with a detailed error message. If the user is not found, a 404 status code is returned with an appropriate error message.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Remove Dependency Between Job Properties

  • ID: delete_dependency_between_job_properties
  • Operation: write
  • Entities: job property, dependent
  • Summary: This API endpoint is used to remove a dependency between job properties in the SmartRecruiters system. It requires two path parameters: 'id', which is the job property identifier, and 'dependentId', which is the job property's dependent identifier. The request does not require a body or query parameters. The response can be a 204 status code indicating successful deletion with no content, a 403 status code indicating forbidden access due to authorization issues, or a 404 status code indicating that the job property or its dependent was not found. The 403 and 404 responses include a JSON body with a message and an array of errors, each containing a code and a message.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Remove Hiring Team Member from Job

  • ID: delete_hiring_team_member_from_job
  • Operation: write
  • Entities: user, hiring team, job
  • Summary: This API endpoint is used to remove a member from the hiring team of a specified job. The request requires the job ID and user ID as path parameters. The request header must include 'accept: application/json'. If successful, the response will be a 204 No Content status. If there are errors, such as attempting to remove the last member of a hiring team, lacking job access, or the user not being a member of the hiring team, the response will include error messages with appropriate status codes (400, 401, 404).
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Interview

  • ID: delete_interview
  • Operation: write
  • Entities: interview
  • Summary: The Delete Interview API allows users to delete an interview by providing the interview ID in the path parameters. The request requires the 'interviewId' as a path parameter, which is a GUID string representing the ID of the interview to be deleted. The API responds with a 204 status code if the interview is successfully deleted. If the user is forbidden from deleting the interview, a 403 status code is returned with an error message. If the interview is not found, a 404 status code is returned with an error message indicating 'INTERVIEW_NOT_FOUND'. A 500 status code indicates an unexpected error.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Interview Timeslot

  • ID: delete_interview_timeslot
  • Operation: write
  • Entities: timeslot, interview
  • Summary: This API endpoint allows the deletion of a specific timeslot associated with an interview. It requires the 'interviewId' and 'timeslotId' as path parameters, both of which are GUIDs. The request must include an 'accept' header with the value 'application/json'. A successful deletion returns a 204 status code. If the user is forbidden from deleting the timeslot, a 403 status code is returned with an error message. Other possible responses include 404 if the interview or timeslot is not found, 409 if the last timeslot cannot be deleted, and 500 for unexpected errors.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Interview Type

  • ID: delete_interview_type
  • Operation: write
  • Entities: interview type
  • Summary: The Delete Interview Type API allows users to delete a specific interview type by providing the interview type name as a path parameter. The request requires the 'interviewType' path parameter, which is a string with a maximum length of 400 characters. The API responds with a 204 status code if the interview type is successfully deleted. If the user is forbidden to delete the interview type, a 403 status code is returned with an error message. If the interview type is not found, a 404 status code is returned with an error message. In case of an unexpected error, a 500 status code is returned.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Job Application

  • ID: delete_job_application
  • Operation: write
  • Entities: job application
  • Summary: The Delete Job Application API allows users to delete a job application identified by a given job application ID. The API requires the jobApplicationId as a path parameter, which must be a valid UUID. The request does not require a body or specific headers, but it can accept 'application/json' as a response format. Upon successful deletion, the API returns a 204 status code. If the jobApplicationId is invalid, a 400 status code is returned with an error message. If the job application is not found, a 404 status code is returned with an error message.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Job Position

  • ID: delete_job_position
  • Operation: write
  • Entities: position, job, candidate
  • Summary: This API endpoint is used to delete a specific job position identified by the jobId and positionId path parameters. The DELETE method is used to remove the position. The request requires the jobId and positionId as path parameters. The response can be a 204 status code indicating successful removal, or error responses such as 400 if the position has a candidate assigned, 403 if the approval process is enabled or access is forbidden, and 404 if the position is not found. The error responses include a message and an array of errors with codes and messages.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Message by ID

  • ID: delete_message_by_id
  • Operation: write
  • Entities: message
  • Summary: This API endpoint allows the deletion of a message by its ID. The DELETE method is used to remove a message from the system, making it no longer visible on Hireloop. The request requires the 'id' path parameter, which is the identifier of the message to be deleted. The response can be a 204 status code indicating successful deletion, a 403 status code indicating no permission to delete the message, or a 404 status code indicating that the message was not found. The 403 and 404 responses include a JSON body with a message and an array of errors, each containing a code and a message.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Remove Relationship Between Dependent Job Properties Values

  • ID: delete_relationship_between_dependent_job_properties_values
  • Operation: write
  • Entities: job property, relationship, dependent value
  • Summary: This API endpoint is used to remove the relationship between dependent job properties values. It requires the identifiers for the job property, its value, the dependent property, and the dependent value as path parameters. The DELETE method is used to perform this operation. If successful, the API returns a 204 status code with no content. If the request is forbidden due to authorization issues, a 403 status code is returned with a message and errors. If any of the specified identifiers are not found, a 404 status code is returned with detailed error codes and messages.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Review by ID

  • ID: delete_review_by_id
  • Operation: write
  • Entities: reviewer, review
  • Summary: The Delete Review by ID API allows users to delete a specific review by providing the review ID and reviewer ID. The request requires an 'accept' header with 'application/json' and a query parameter 'reviewerId' which must be a 24-character hexadecimal string. The response will be a 204 status code if the review is successfully deleted. If there are errors, such as invalid IDs or unauthorized access, the response will include error codes and messages detailing the issue.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Unarchive Job Property Value

  • ID: delete_unarchive_job_property_value
  • Operation: write
  • Entities: job property, value
  • Summary: The 'Unarchive Job Property Value' API allows users to unarchive a specific job property value by providing the job property identifier and the value identifier in the path parameters. The request requires an 'accept' header with the value 'application/json'. The API does not require a request body or query parameters. Upon successful execution, the API returns a 204 status code with no content. If the user does not have the necessary authorization, a 403 status code is returned with an error message. If the job property or value does not exist, a 404 status code is returned with an appropriate error message. If the value label contains invalid characters, a 422 status code is returned, indicating that the label must be updated before unarchiving.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Unpublish Job Ad from All Sources

  • ID: delete_unpublish_job_ad
  • Operation: write
  • Entities: source, job, job ad
  • Summary: This API endpoint is used to unpublish a job ad from all sources. It requires the job identifier (jobId) and the job ad identifier (jobAdId) as path parameters. The request does not require a body or query parameters. The response can be a 202 status indicating the unposting is pending, a 401 status if the user is not authorized, or a 404 status if the job ad is not found. The response body for a 202 status includes the unposting status, while 401 and 404 responses include error messages and codes.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Unpublish Job from All Sources

  • ID: delete_unpublish_job_from_all_sources
  • Operation: write
  • Entities: source, job, user
  • Summary: This API endpoint unpublishes a job from all sources. It requires the job identifier as a path parameter. The request must include an 'accept' header with the value 'application/json'. The API does not require a request body. On success, it returns a 204 status code with no content. If the user is not authorized to access the job, it returns a 401 status code with an error message and error code 'UNAUTHORIZED_TO_ACCESS_JOB'.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Deactivate User Activation

  • ID: delete_user_activation
  • Operation: write
  • Entities: user
  • Summary: The Deactivate User Activation API allows you to deactivate a user's activation status by sending a DELETE request to the specified endpoint. The request requires a path parameter 'id', which is the user identifier. The response can be a 204 status code indicating successful deactivation, a 403 status code indicating permission denied if the user is not permitted to manage users, or a 404 status code if the user is not found. The 403 and 404 responses include a JSON body with a message and an array of errors, each containing a code and message.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete User from Access Group

  • ID: delete_user_from_access_group
  • Operation: write
  • Entities: user, access group
  • Summary: This API endpoint is used to delete a user from a specified access group. It requires the access group identifier and the user identifier as path parameters. The request can include an 'accept' header to specify the media type for the response. If successful, it returns a 204 status code indicating the user was successfully removed. If the user is not permitted to manage access groups, a 403 status code is returned with a detailed error message. If the user is not found or not in the access group, a 404 status code is returned with a detailed error message.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Webhook Subscription

  • ID: delete_webhook_subscription
  • Operation: write
  • Entities: subscription, webhook
  • Summary: The Delete Webhook Subscription API allows users to delete a webhook subscription by specifying the subscription identifier in the path parameter. The API requires the 'id' path parameter, which is a UUID representing the subscription identifier. The request can include an 'accept' header to specify the media type for the response, though it is optional. Upon successful deletion, a 204 status code is returned. If the user does not have permission to delete the subscription, a 403 status code is returned with an error message. If the subscription is not found, a 404 status code is returned with an error message.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Access Groups

  • ID: get_access_groups
  • Operation: read
  • Entities: user, access group
  • Summary: The Get Access Groups API retrieves a list of access groups from the SmartRecruiters platform. It requires an 'accept' header specifying 'application/json'. The response includes a 200 status code with a list of access groups, each having an 'id' and 'name'. If the user does not have permission to manage access groups, a 403 status code is returned with a 'PERMISSION_DENIED' error message.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Application Configuration for Posting

  • ID: get_application_configuration_for_posting
  • Operation: read
  • Entities: configuration, policy, question
  • Summary: This API endpoint retrieves the application configuration for a specific job posting identified by the UUID. The configuration includes screening questions, privacy policies, and settings. Optionally, conditional questions can be included in the response. The request requires the UUID as a path parameter and accepts an optional 'Accept-Language' header to specify the language for screening questions, defaulting to 'en'. Additionally, a query parameter 'conditionalsIncluded' can be used to specify whether conditional questions should be included in the response. The response includes details about questions, settings, and privacy policies. Error responses include codes and messages for invalid requests, unauthenticated access, too many requests, and internal server errors.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Approval Request Comments

  • ID: get_approval_request_comments
  • Operation: read
  • Entities: comment, error, approval request
  • Summary: This API endpoint retrieves comments for a specific approval request identified by the 'approvalRequestId' path parameter. The request requires an 'accept' header with the value 'application/json'. The response includes a 200 status code with a list of comments, each containing 'content', 'authorId', and 'createdOn' fields. If the approval request is not found, a 404 status code is returned with an error code 'APPROVAL_REQUEST_NOT_FOUND'.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Approval Request Details

  • ID: get_approval_request_details
  • Operation: read
  • Entities: approver, job, approval request
  • Summary: This API retrieves the details of an approval request using the specified approvalRequestId. The request requires the 'accept' header to be set to 'application/json'. The path parameter 'approvalRequestId' is mandatory and identifies the specific approval request. The response includes details such as the approval request id, subject, type, decision mode, status, and steps involved in the approval process. If the approval request is found, a 200 status code is returned with the approval details. If not found, a 404 status code is returned with an error code and message.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Approval Requests

  • ID: get_approval_requests
  • Operation: read
  • Entities: approver, approval request
  • Summary: This API endpoint retrieves a list of approval requests from the SmartRecruiters platform. The maximum number of approval requests returned is 100. The request is made using the GET method to the specified URL. The API accepts an optional query parameter 'pageId' to paginate through the list of approval requests. The response includes a list of approval requests with details such as id, subject, type, decision mode, status, and steps required for approval. The response headers may include a 'Link' header for pagination. In case of an error, such as an invalid pageId, a 400 response is returned with error details.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Retrieve Assessment Orders

  • ID: get_assessment_orders
  • Operation: read
  • Entities: assessment, application, assessment order
  • Summary: The Retrieve Assessment Orders API endpoint allows clients to fetch assessment orders associated with a specific application ID. The request requires a query parameter 'applicationId' which is a GUID representing the application. The response includes an array of assessment orders, each containing details such as applicationId, orderId, assessmentPackageDate, submissionDate, assessmentPackageName, description, status, score, scoreLabel, summary, attachments, and assessments. The API returns a 200 status code with the assessment orders if successful, a 401 status code if the caller is not authorized, a 404 status code if the application is not found, and a 500 status code for unexpected errors.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Assessment Package Details

  • ID: get_assessment_package_details
  • Operation: read
  • Entities: assessment, assessment package
  • Summary: This API endpoint retrieves the details of a specific assessment package identified by the 'assessmentPackageId' path parameter. The request requires the 'assessmentPackageId' to be provided in the URL path. The response includes details such as the package ID, type, name, description, and a list of assessments within the package. The response can return a 200 status with the package details, a 401 status if the request is unauthorized, a 403 status if required scopes are missing, or a 404 status if no package is found with the given ID.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Assignment Details for Onboarding Process

  • ID: get_assignment_details_for_onboarding_process
  • Operation: read
  • Entities: onboarding process, assignment
  • Summary: This API endpoint retrieves the details of a specific assignment within an onboarding process. It requires the 'onboardingProcessId' and 'assignmentId' as path parameters, both of which must be valid UUIDs. The request must include an 'accept' header with the value 'application/json'. The response will include details such as the assignment's ID, type, title, description, and flags indicating if it contains sensitive data or is high priority. Possible response codes include 200 for a successful retrieval, 401 if the caller is not authorized, 404 if the assignment is not found, and 500 for unexpected errors.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Attachment for Activity Assignment

  • ID: get_attachment_for_activity_assignment
  • Operation: read
  • Entities: activity assignment, attachment
  • Summary: This API retrieves a single attachment for a given activity assignment. It requires the 'activityAssignmentId' and 'attachmentId' as path parameters, both of which must be valid UUIDs. The request must include an 'accept' header with the value 'application/octet-stream'. The response will return the attachment in binary format if successful (HTTP 200). If the caller is not authorized, a 401 error with a NOT_AUTHORIZED_TO_ACCESS_RESOURCE code will be returned. If the activity assignment or attachment is not found, a 404 error with appropriate codes will be returned. A 500 error indicates an unexpected error.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Attachments for Activity Assignment

  • ID: get_attachments_for_activity_assignment
  • Operation: read
  • Entities: activity assignment, attachment
  • Summary: This API retrieves the attachments associated with a specific activity assignment. The request requires the 'activityAssignmentId' as a path parameter, which is a UUID representing the ID of the activity assignment. The request header must include 'accept: application/json'. The response will return a list of attachment IDs if successful (HTTP 200). If the caller is not authorized, a 401 error with a NOT_AUTHORIZED_TO_ACCESS_RESOURCE code is returned. If the activity assignment is not found, a 404 error with an ACTIVITY_ASSIGNMENT_NOT_FOUND code is returned. A 500 error indicates an unexpected error.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Retrieve Audit Events

  • ID: get_audit_events
  • Operation: read
  • Entities: user, job, candidate
  • Summary: The Retrieve Audit Events API allows users to fetch a list of audit events from the SmartRecruiters system. The API supports filtering by event date, event name, author type, author ID, entity type, and entity ID. It returns a paginated list of events, each with details such as event name, date, author type, and context information. The API retains data for at least 26 months and defaults to the last 7 days if no date range is specified. The response includes a nextPageId for pagination and a limit on the number of events returned.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Available Entity Names for Entity Mapping

  • ID: get_available_entity_names_for_entity_mapping
  • Operation: read
  • Entities: entity name, entity mapping
  • Summary: [BETA] This API endpoint retrieves the available entity names for entity mapping. It is a GET request to the URL 'https://api.smartrecruiters.com/configuration/entity-mapping/entity-names'. The request requires an 'accept' header with the value 'application/json'. The response can be a 200 status with a list of entity names, a 403 status indicating forbidden access due to authorization issues, or a 404 status indicating that the mapping was not found. The 200 response includes an array of entity names, each with a 'name' property. The 403 and 404 responses include a 'message' and an array of 'errors', each with a 'code' and 'message'.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Available Job Properties

  • ID: get_available_job_properties
  • Operation: read
  • Entities: job property, action, organization
  • Summary: This API endpoint retrieves a list of available job properties from the SmartRecruiters platform. The request is made using the GET method to the URL https://api.smartrecruiters.com/configuration/job-properties. The API accepts an optional header 'Accept-Language' to specify the language of the returned content. The response includes a 200 status code with a JSON object containing 'totalFound' and 'content' fields, where 'content' is an array of job property objects. Each job property object includes fields such as 'id', 'label', 'category', 'active', 'visible', 'required', and 'actions'. A 403 status code indicates forbidden access, with a response containing a 'message' and 'errors' array detailing the issue.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Available Job Property Values

  • ID: get_available_job_property_values
  • Operation: read
  • Entities: job property, configuration, value
  • Summary: This API endpoint retrieves available job property values for a specified job property ID. It supports optional language specification through the 'Accept-Language' header, and pagination through 'pageId' and 'pageSize' query parameters. The response includes the total number of items found, the next page ID for pagination, and a list of job property values with their IDs, labels, and archived status. Possible error responses include 403 Forbidden if access is denied, and 404 Not Found if the job property does not exist.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Available Offer Properties

  • ID: get_available_offer_properties
  • Operation: read
  • Entities: property, offer, category
  • Summary: This API endpoint retrieves a list of available offer properties from the SmartRecruiters platform. It requires an 'accept' header with the value 'application/json'. The response includes a list of categories, each containing an ID and a list of properties. Each property has a key, label, required status, and type, which can be one of several enumerated types such as BOOLEAN, COUNTRY, CURRENCY, etc. If the user does not have permission to access offers, a 403 error is returned with a message and a list of errors.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List Available Values for Candidate Property

  • ID: get_available_values_for_candidate_property
  • Operation: read
  • Entities: candidate property value, candidate property
  • Summary: This API endpoint lists all available values for a given candidate property ID. It is specifically available for candidate properties of type SINGLE_SELECT. The request requires the 'id' path parameter, which is the candidate property identifier. The response includes a list of values with their IDs and labels if successful (HTTP 200). If the candidate property type is not SINGLE_SELECT, a 400 error is returned with code CANDIDATE_PROPERTY_NOT_SINGLE_SELECT. If the candidate property is not found, a 404 error is returned.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Callback Logs for Subscription

  • ID: get_callback_logs_for_subscription
  • Operation: read
  • Entities: callback request, subscription
  • Summary: This API endpoint retrieves the callback logs for a specific subscription identified by the 'id' path parameter. It supports filtering the logs based on query parameters such as 'page_id', 'limit', 'callbackStatus', 'after', and 'before'. The response includes a list of callback request details, each containing the status, timestamp, and request details including the URL, body, and headers. The 'Link' header in the response provides a link to the next set of resources if available.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Candidate Consent Decisions

  • ID: get_candidate_consent_decisions
  • Operation: read
  • Entities: consent, candidate, customer
  • Summary: This API endpoint retrieves the consent decisions of a candidate based on the consent approach chosen by the customer. The response can either be a single consent decision or multiple decisions broken out by data scopes such as SmartRecruit and SmartCRM. If there is at least one pending consent request for a candidate, the response includes the date and time of the most recent request. The API requires the candidate's ID as a path parameter and returns a JSON object with the consent decisions. A 403 response indicates access denial with an error message.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Candidate Consent Status

  • ID: get_candidate_consent_status
  • Operation: read
  • Entities: consent status, candidate
  • Summary: This API endpoint retrieves the consent status of a candidate using their unique identifier. The request is made using the GET method to the URL 'https://api.smartrecruiters.com/candidates/{id}/consent'. The path parameter 'id' is required and represents the candidate's identifier. The request header must include 'accept: application/json'. The response will return a 200 status code with the candidate's latest consent status, which can be 'REQUIRED', 'PENDING', or 'ACQUIRED'. If the status is 'ACQUIRED', a date will also be provided. A 403 status code indicates that access to the candidate is denied, and an error message will be included in the response.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Candidate Details

  • ID: get_candidate_details
  • Operation: read
  • Entities: job, assignment, candidate
  • Summary: This API endpoint retrieves the details of a candidate using their unique identifier. The request requires the 'id' path parameter, which is the candidate's identifier, and an 'accept' header specifying 'application/json'. The response includes detailed information about the candidate, such as personal details, location, web presence, education, experience, and assignments. The response also includes actions related to the candidate's assignments and consents. In case of unauthorized access, a 401 error is returned with a message and error details.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Candidate Job Offers

  • ID: get_candidate_job_offers
  • Operation: read
  • Entities: job, candidate, offer
  • Summary: This API endpoint retrieves the job offers for a specific candidate identified by the 'id' path parameter and a specific job identified by the 'jobId' path parameter. The request requires an 'accept' header with the value 'application/json'. The response includes a list of offers with details such as offer ID, status, creation and update timestamps, and associated actions. Possible response statuses include 200 (success), 401 (access denied), 403 (no access to offers), and 404 (offers not found).
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Candidate Job Properties

  • ID: get_candidate_job_properties
  • Operation: read
  • Entities: property, job, candidate
  • Summary: This API endpoint retrieves the properties of a candidate for a specific job. It requires the candidate ID and job ID as path parameters. An optional query parameter 'context' can be provided to specify the context for candidate properties to display, which can be one of PROFILE, OFFER_FORM, HIRE_FORM, or OFFER_APPROVAL_FORM. The response includes a list of candidate properties with details such as id, label, type, value, and actions. If the candidate properties cannot be accessed, a 403 error is returned. If the candidate is not assigned to the given job, a 404 error with code JOB_NOT_FOUND is returned.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Candidate Job Reviews

  • ID: get_candidate_job_reviews
  • Operation: read
  • Entities: job, review, candidate
  • Summary: This API endpoint retrieves reviews for a specific candidate related to a specific job. It requires two query parameters: 'candidateId' and 'jobId', both of which are GUIDs and are mandatory. The response can be a list of reviews with details such as review ID, candidate ID, job ID, reviewer ID, overall rating, comment, and timestamps for creation and update. Possible error responses include 401 for unauthorized access and 404 if no application is found for the candidate in the specified job.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Candidate Offer Details

  • ID: get_candidate_offer_details
  • Operation: read
  • Entities: job, candidate, offer
  • Summary: This API endpoint retrieves the details of a candidate's offer using the specified offer ID. The request requires the 'accept' header to be set to 'application/json'. The path parameter 'offerId' is mandatory and identifies the specific offer to be retrieved. The response includes the offer's ID, status, creation and update timestamps, additional properties, and actions related to the candidate, job, and details. Possible response statuses include 200 for a successful retrieval, 401 for access denial, 403 for no access to offers, and 404 if the offer is not found.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Candidate Properties Configuration

  • ID: get_candidate_properties_configuration
  • Operation: read
  • Entities: company, candidate property, configuration
  • Summary: This API endpoint retrieves all candidate properties and their configuration for a company. It requires an 'accept' header with the value 'application/json'. The response includes a list of candidate properties with details such as id, label, type, availability, and actions. The availability specifies to whom and in what context the property is available, while actions provide URLs and methods for further operations. A 403 response indicates permission denial, with an error message and code.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Candidate Property Details

  • ID: get_candidate_property_details
  • Operation: read
  • Entities: property, configuration, candidate
  • Summary: This API endpoint retrieves the details and configuration of a candidate property by its identifier. The request requires a path parameter 'id' which is the candidate property identifier. The response includes details such as the property id, label, type, availability, and actions. The type can be one of several enumerated values such as BOOLEAN, COUNTRY, CURRENCY, etc. The availability object specifies the users and contexts where the property is available. If the candidate property is not found, a 404 response is returned with an error message.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Candidate Property Value by ID

  • ID: get_candidate_property_value_by_id
  • Operation: read
  • Entities: candidate property value, candidate property
  • Summary: This API endpoint retrieves a candidate property value by its ID. It requires two path parameters: 'id', which is the candidate property identifier, and 'valueId', which is the candidate property's value identifier. The request must include an 'accept' header with the value 'application/json'. The response can be a 200 status with the candidate property value details, a 400 status if the candidate property type is not SINGLE_SELECT, or a 404 status if the candidate property or value with the given ID does not exist.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Candidate Screening Question Answers

  • ID: get_candidate_screening_question_answers
  • Operation: read
  • Entities: job, screening question, candidate
  • Summary: This API endpoint retrieves the screening question answers for a specific candidate's job. It requires the candidate identifier and job identifier as path parameters. The response includes the total number of answers found and an array of answer details, each containing the question ID, type, category, name, label, and records. The records include fields with IDs, labels, and values. The API returns an empty array if no screening answers are found. The response also includes predefined and custom questions, with labels used for human-readable formats.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Candidate Source by Identifier

  • ID: get_candidate_source_by_identifier
  • Operation: read
  • Entities: source, identifier, candidate
  • Summary: This API endpoint retrieves a single candidate source based on the provided source identifier, which can include deleted sources. The request requires a path parameter 'sourceIdentifier' which must be a valid UUID. The response can be a successful retrieval of the source details with properties like 'label', 'type', and 'subType', or it can return error messages for invalid identifiers or if the source is not found.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Candidate Source Types with Subtypes

  • ID: get_candidate_source_types_with_subtypes
  • Operation: read
  • Entities: source, subtype, action
  • Summary: This API endpoint retrieves a list of all available candidate source types along with their subtypes. It requires an 'accept' header specifying 'application/json'. The response includes the total number of source types found and a detailed list of each source type, including its id, label, available actions with URLs and HTTP methods, and a list of subtypes with their ids.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Candidate Sources by Type

  • ID: get_candidate_sources_by_type
  • Operation: read
  • Entities: source, action, candidate
  • Summary: This API endpoint retrieves a list of all available candidate sources by type. The request requires a path parameter 'sourceType' to specify the type of source to retrieve. Optional query parameters include 'sourceSubType' to filter by subtype, 'limit' to specify the number of elements to return (default is 100, max is 100), and 'offset' to specify the number of elements to skip (default is 0). The response includes a list of candidate sources with details such as 'id', 'label', 'sourceIdentifier', 'sourceSubType', and 'actions'. Possible response codes include 200 for a successful retrieval, 400 for invalid source type and subtype pair, and 404 if the source is not found.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Candidate Status for a Posting

  • ID: get_candidate_status_for_a_posting
  • Operation: read
  • Entities: status, posting, candidate
  • Summary: This API endpoint retrieves the status of a candidate for a specific job posting. It requires the 'uuid' of the posting and the 'candidateId' as path parameters. The request should include an 'accept' header with the value 'application/json'. The response will return the candidate's status, which can be one of several predefined states such as 'NEW', 'IN_REVIEW', 'INTERVIEW', etc. In case of errors, the API will return appropriate error codes and messages.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Candidate Tags

  • ID: get_candidate_tags
  • Operation: read
  • Entities: tag, candidate
  • Summary: This API endpoint retrieves the tags associated with a specific candidate identified by the 'id' path parameter. The request requires an 'accept' header with the value 'application/json'. The response will return a list of tags in JSON format if successful (HTTP 200), or an error message if the user does not have permission to access the candidate (HTTP 403). The 'tags' array in the response can contain up to 100 string items, each with a maximum length of 50 characters.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Candidate's Attachment

  • ID: get_candidates_attachment
  • Operation: read
  • Entities: candidate, attachment
  • Summary: This API endpoint retrieves a candidate's attachment using the specified attachment identifier. The request requires the 'attachmentId' as a path parameter and the 'accept' header set to 'application/json'. The response can be a successful retrieval of the attachment or an error message. Possible error responses include 403 for permission issues or malware detection, and 404 if the file is not found.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Candidate's Attachments for a Job

  • ID: get_candidates_attachments_for_a_job
  • Operation: read
  • Entities: candidate, job, attachment
  • Summary: This API endpoint retrieves a list of attachments associated with a candidate for a specific job. The request requires the candidate's ID and the job ID as path parameters. The response includes the total number of attachments found and details of each attachment, such as its ID, name, type, content type, and available actions (download and remove). If the user does not have permission to view the attachments, a 403 error is returned with a PERMISSION_DENIED code. If the candidate is not assigned to the specified job, a 404 error is returned with a JOB_NOT_FOUND code.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Candidate's Job Application Details

  • ID: get_candidates_job_application_details
  • Operation: read
  • Entities: candidate, job, application
  • Summary: This API endpoint retrieves the details of a candidate's application to a specific job. It requires the candidate's ID and the job ID as path parameters. The response includes the application ID, status, sub-status, start date, source, reasons for rejection or withdrawal, actions, and the URL of the application details. The API returns a 200 status code with the application details if successful, a 403 status code if permission is denied, and a 404 status code if the application is not found.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Retrieve Candidates Matching Criteria

  • ID: get_candidates_matching_criteria
  • Operation: read
  • Entities: job, location, candidate
  • Summary: This API endpoint retrieves candidates matching specified criteria from the SmartRecruiters platform. It supports various query parameters for filtering candidates, such as keyword search, job ID, location, status, consent status, and more. The response includes candidate details like ID, name, email, location, and job assignments. Pagination is supported through the 'limit' and 'pageId' query parameters, with links to the next page provided in the response headers. The API returns a JSON object containing the list of candidates and metadata about the search results.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Candidate's Status History for a Job

  • ID: get_candidates_status_history_for_a_job
  • Operation: read
  • Entities: job, status history, candidate
  • Summary: This API endpoint retrieves the status history of a candidate for a specific job. It requires the candidate's ID and the job ID as path parameters. The response includes the total number of status history records found and an array of status changes, each with a timestamp, status, sub-status, and possible actions. If the user does not have access to the candidate or job, a 403 error is returned with appropriate error codes. If the candidate or job is not found, a 404 error is returned.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Company Information

  • ID: get_company_information
  • Operation: read
  • Entities: company, location, industry
  • Summary: This API endpoint retrieves all information about a company. It requires an 'accept' header with the value 'application/json'. The response includes details such as the company's identifier, name, location (including country, country code, region, city, address, postal code, longitude, and latitude), website URL, industry information (id and label), and logo URL.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Department Configuration

  • ID: get_department_configuration
  • Operation: read
  • Entities: department
  • Summary: The Get Department Configuration API retrieves a list of departments configured in the system. It accepts an optional 'Accept-Language' header to specify the language of the returned content. The response includes the total number of departments found and an array of department objects, each containing an id, label, description, and archived status.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Department Details

  • ID: get_department_details
  • Operation: read
  • Entities: department
  • Summary: This API endpoint retrieves the details of a specific department using its identifier. The request requires the 'id' path parameter, which is the unique identifier of the department. The request header must include 'accept: application/json'. The response will return a 200 status code with department details including 'id', 'label', 'description', and 'archived' status if the department is found. If the department is not found, a 404 status code is returned with an error message.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Dependent Job Property Values

  • ID: get_dependent_job_property_values
  • Operation: read
  • Entities: job property, value, dependent
  • Summary: This API endpoint retrieves the values of a dependent job property in correlation with its parent field. It requires the job property ID and the dependent job property ID as path parameters. The 'Accept-Language' header can be optionally provided to specify the language of the returned content. The response includes the total number of found items and an array of content objects, each containing a parent object with an ID and label, and an array of values with their respective IDs and labels. Possible error responses include 403 Forbidden, indicating authorization issues, and 404 Not Found, indicating missing job properties or dependencies.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Job Content by ID

  • ID: get_details_of_a_specific_job
  • Operation: read
  • Entities:
  • Summary: This API endpoint retrieves the content of a job using a specified job ID. The request is made using the GET method to the URL 'https://api.smartrecruiters.com/jobs/{jobId}'. The request can include an optional 'Accept-Language' header to specify the language of the returned content. The response includes detailed information about the job, such as its ID, title, department, location, status, and more. The response is structured in JSON format and includes various nested objects representing different aspects of the job, such as department details, location information, and job advertisement sections. If access to the job is denied, a 401 response is returned with an error message.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Candidate Details

  • ID: get_details_of_a_specific_job_application
  • Operation: read
  • Entities:
  • Summary: This API endpoint retrieves the details of a candidate using their unique identifier. The request requires the 'id' path parameter, which is the candidate's identifier, and an 'accept' header specifying 'application/json'. The response includes detailed information about the candidate, such as personal details, location, web presence, education, experience, and assignments. The response also includes actions related to the candidate's assignments and consents. In case of unauthorized access, a 401 error is returned with a message and error details.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Download Most Recent Report File

  • ID: get_download_most_recent_report_file
  • Operation: read
  • Entities: report file, report, etag
  • Summary: This API endpoint allows users to download the most recent report file for a specific report in CSV format. The request requires a 'reportId' path parameter to identify the report. Optionally, an 'If-None-Match' header can be included to compare the ETag of the most recent report file, which helps in saving bandwidth by avoiding unnecessary downloads. The response includes the report data in CSV format and an ETag header. If the report file is not newer than the one referred in the 'If-None-Match' header, a 304 Not Modified status is returned. The API also handles various error responses such as 400 for invalid report ID, 401 for unauthenticated requests, 403 for unauthorized access, and 404 when no report file is found.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Download Report File

  • ID: get_download_report_file
  • Operation: read
  • Entities: file, report, data
  • Summary: This API endpoint allows users to download a specific report file in CSV format using the GET method. The request requires a path parameter 'reportFileId' which is the identifier of the report file to be downloaded. The 'accept' header must be set to 'text/csv' to specify the format of the response data. The response will contain the report data in CSV format if successful (HTTP 200). If the request is not authenticated, a 401 error will be returned with a message and error details. If the caller is not authorized, a 403 error will be returned. If no report file is found with the given ID, a 404 error will be returned.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Fillable PDF Form Assignment Answers

  • ID: get_fillable_pdf_form_assignment_answers
  • Operation: read
  • Entities: pdf, fillable pdf form assignment, form answer
  • Summary: This API retrieves the answers submitted for a specific Fillable PDF Form Assignment. The request requires the 'fillablePdfFormAssignmentId' as a path parameter, which is the unique identifier of the form assignment. The response is a PDF file filled with the submitted answers if successful (HTTP 200). If the caller is not authorized, a 401 error is returned with a NOT_AUTHORIZED_TO_ACCESS_RESOURCE code. If the form assignment or its answers are not found, a 404 error is returned with appropriate error codes. A 500 error indicates an unexpected server error.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Hiring Process Details

  • ID: get_hiring_process_details
  • Operation: read
  • Entities: hiring process, sub status, error
  • Summary: This API endpoint retrieves the details of a specific hiring process identified by the 'id' path parameter. The request requires an 'accept' header with the value 'application/json'. The response includes the hiring process details such as 'id', 'name', 'active' status, and 'subStatuses' which include arrays of strings for different statuses like 'IN_REVIEW', 'INTERVIEW', and 'OFFERED'. If the hiring process is not found, a 404 response is returned with an error message and error details.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Hiring Processes

  • ID: get_hiring_processes
  • Operation: read
  • Entities: hiring process, sub status
  • Summary: This API endpoint retrieves a list of hiring processes from the SmartRecruiters platform. It requires an 'accept' header specifying 'application/json' to indicate the expected response format. The response includes the total number of hiring processes found and a detailed list of each process, including its ID, name, active status, and sub-statuses categorized under 'IN_REVIEW', 'INTERVIEW', and 'OFFERED'.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Hiring Team of a Job

  • ID: get_hiring_team_of_a_job
  • Operation: read
  • Entities: user, hiring team, job
  • Summary: This API endpoint retrieves the hiring team for a specific job identified by the jobId. The request is made using the GET method to the URL https://api.smartrecruiters.com/jobs/{jobId}/hiring-team. The request can include an optional 'Accept-Language' header to specify the language of the returned content. The response includes a list of team members with their roles and actions. If the job access is denied, a 401 error is returned with a message and error details.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Interview Details

  • ID: get_interview_details
  • Operation: read
  • Entities: user, candidate, interview
  • Summary: This API endpoint retrieves the details of a specific interview using the interview ID. The request requires the 'interviewId' as a path parameter and the 'accept' header set to 'application/json'. The response includes details such as the candidate, job ID, organizer ID, timezone, and timeslots. The timeslots contain information about the interview type, title, place, start and end times, interviewers, candidate status, and no-show status. The API returns a 200 status code with the interview details, a 403 status code if access is forbidden, a 404 status code if the interview is not found, and a 500 status code for unexpected errors.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Interview Timeslot Details

  • ID: get_interview_timeslot_details
  • Operation: read
  • Entities: timeslot, user, interview
  • Summary: This API endpoint retrieves the details of a specific interview timeslot. It requires the interview ID and timeslot ID as path parameters. The response includes details such as the interview type, title, place, start and end times, interviewers, candidate status, and no-show status. If access is forbidden, a 403 error with error details is returned. If the interview or timeslot is not found, a 404 error is returned. A 500 error indicates an unexpected error.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Interview Types

  • ID: get_interview_types
  • Operation: read
  • Entities: interview type, interview
  • Summary: The 'Get Interview Types' API retrieves a list of interview types from the SmartRecruiters platform. It is a GET request to the endpoint 'https://api.smartrecruiters.com/interviews-api/v201904/interview-types'. The request requires an 'accept' header with the value 'application/json' to specify the expected media type in the response. The response returns a JSON array of strings, each representing an interview type, with a minimum of 1 and a maximum of 2000 items. In case of an unexpected error, a 500 status code is returned.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Job Ads for a Specific Job

  • ID: get_job_ads_for_a_specific_job
  • Operation: read
  • Entities: job, job ad, location
  • Summary: This API endpoint retrieves job advertisements for a specific job identified by the jobId path parameter. The request can include an optional 'Accept-Language' header to specify the language of the returned content. The response includes an array of job ads, each containing details such as id, title, language, location, job description, creation and update timestamps, posting status, and visibility. The response also includes actions that can be performed on the job ad, such as posting methods and URLs.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Job Advertisement Details

  • ID: get_job_advertisement_details
  • Operation: read
  • Entities: job, job ad, location
  • Summary: This API endpoint retrieves the details of a specific job advertisement using the job ID and job advertisement ID. The request requires the 'Accept-Language' header to specify the language of the returned content, which is optional and defaults to 'en'. The response includes detailed information about the job advertisement, such as its ID, title, language, location, job description, creation and update timestamps, posting status, and visibility. If the job or job advertisement is not found, a 404 error is returned with an appropriate message.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Job Application Details

  • ID: get_job_application_details
  • Operation: read
  • Entities: profile, job, job application
  • Summary: This API endpoint retrieves the details of a job application using the specified job application ID. The request requires the 'jobApplicationId' as a path parameter, which must be a valid UUID. The response includes the status of the job application, sub-status, source identifier, creation date, profile ID, and job ID. The API returns a 200 status code with the job application details if successful. If the 'jobApplicationId' is invalid, a 400 status code is returned with an error message. If the job application is not found, a 404 status code is returned with an error message.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Job Content by ID

  • ID: get_job_content_by_id
  • Operation: read
  • Entities: job, department, location
  • Summary: This API endpoint retrieves the content of a job using a specified job ID. The request is made using the GET method to the URL 'https://api.smartrecruiters.com/jobs/{jobId}'. The request can include an optional 'Accept-Language' header to specify the language of the returned content. The response includes detailed information about the job, such as its ID, title, department, location, status, and more. The response is structured in JSON format and includes various nested objects representing different aspects of the job, such as department details, location information, and job advertisement sections. If access to the job is denied, a 401 response is returned with an error message.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Job Note

  • ID: get_job_note
  • Operation: read
  • Entities: job, error, note
  • Summary: The Get Job Note API retrieves a note associated with a specific job identified by the jobId path parameter. The request can include an optional Accept-Language header to specify the language of the returned content. The response will include the note content if successful (HTTP 200), or an error message if the job access is forbidden (HTTP 401) or the job note is not found (HTTP 404).
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Job Position Details

  • ID: get_job_position_details
  • Operation: read
  • Entities: position, job
  • Summary: This API endpoint retrieves the details of a specific job position using the job ID and position ID. It requires the 'Accept-Language' header to specify the language of the returned content, which defaults to 'en'. The response includes details such as the position ID, type, incumbent name, position open date, target start date, creation date, and status. If the job access is forbidden, a 403 error is returned with a message and error details. If the position is not found, a 404 error is returned with a message and error details.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Job Positions

  • ID: get_job_positions
  • Operation: read
  • Entities: position, job
  • Summary: The Get Job Positions API retrieves the list of positions for a specific job identified by the jobId path parameter. It accepts optional headers such as 'Accept-Language' to specify the language of the returned content and 'accept' to specify the media type, which defaults to 'application/json'. The response includes a list of positions with details such as position ID, type, incumbent name, open date, target start date, creation date, and status. If access to the job is forbidden, a 403 error is returned with an error message and code.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Job Posting Details

  • ID: get_job_posting_details
  • Operation: read
  • Entities: company, location, job posting
  • Summary: This API endpoint retrieves the details of a specific job posting for a given company. The request requires the company identifier and the posting identifier as path parameters. Optional query parameters include sourceTypeId, sourceSubTypeId, and sourceId, which are used for source tracking. The 'accept-language' header can be used to specify the language of translation. The response includes detailed information about the job posting, such as its ID, name, URLs, company details, location, industry, department, function, type of employment, experience level, custom fields, creator, job advertisement sections, and visibility status.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Job Property by ID

  • ID: get_job_property_by_id
  • Operation: read
  • Entities: job property, organization
  • Summary: This API endpoint retrieves a job property by its ID. The request is made using the GET method to the URL 'https://api.smartrecruiters.com/configuration/job-properties/{id}', where '{id}' is the path parameter representing the job property ID. The request can include an optional 'Accept-Language' header to specify the language of the returned content. The response includes a 200 status code with details of the job property, including its ID, label, category, active status, visibility, requirement status, and available actions. If the request is unauthorized, a 403 status code is returned with an error message. If the job property is not found, a 404 status code is returned with an error message.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Job Publications

  • ID: get_job_publications
  • Operation: read
  • Entities: source, publication, job
  • Summary: This API endpoint retrieves the list of publications for a specific job identified by the jobId. It supports filtering publications based on their active status using the 'activeOnly' query parameter. The response includes details such as the source name, type, published date, unpublished date, and posting ID of each publication. The API supports multiple languages for the response content, specified via the 'Accept-Language' header. If the user is unauthorized to access the job, a 401 error with a specific error code is returned.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Job Status History

  • ID: get_job_status_history
  • Operation: read
  • Entities: status, job, history
  • Summary: The Get Job Status History API retrieves the history of status changes for a specific job identified by the jobId path parameter. The API supports an optional Accept-Language header to specify the language of the returned content. The response includes a totalFound field indicating the number of status changes and a content array with details of each status change, including the changedOn date, status, and any user actions. If access is forbidden, a 401 response is returned with an error message and code.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Retrieve Last Secret Key for Webhook Subscription

  • ID: get_last_secret_key_for_webhook_subscription
  • Operation: read
  • Entities: webhook subscription, error, secret key
  • Summary: This API retrieves the last secret key for a specified webhook subscription. The request requires the subscription identifier as a path parameter. The response will include the secret key if the request is successful (HTTP 200). If the user does not have permission to retrieve the secret key, a 403 error will be returned with an error message. If the subscription is not found, a 404 error will be returned with an error message.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Latest Approval Request for Offer

  • ID: get_latest_approval_request_for_offer
  • Operation: read
  • Entities: job, candidate, offer
  • Summary: This API endpoint retrieves the latest approval request for a given offer. It requires the 'offerId' as a path parameter to identify the specific offer. The request must include an 'accept' header with the value 'application/json'. The response can be a successful retrieval of the approval request ID (HTTP 200) or various error responses such as unauthorized access (HTTP 401), forbidden access (HTTP 403), or not found errors (HTTP 404) with appropriate error messages and codes.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Latest Job Approval Details

  • ID: get_latest_job_approval_details
  • Operation: read
  • Entities: position, job, approval request
  • Summary: This API endpoint retrieves the latest approval details for a specific job identified by the jobId path parameter. The request can include an optional 'Accept-Language' header to specify the language of the returned content. The response includes details such as the approval request ID, positions associated with the job, and salary range. Possible response codes include 200 for successful retrieval, 401 for forbidden access, 403 for no access to approvals, and 404 if no approvals are found for the job.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List Active Postings by Company

  • ID: get_list_active_postings_by_company
  • Operation: read
  • Entities: company, posting, location
  • Summary: This API endpoint lists active job postings published by a specified company. It requires the 'companyIdentifier' as a path parameter to identify the company. Optional query parameters include 'q' for full-text search, 'limit' and 'offset' for pagination, 'destination' and 'locationType' for filtering postings by type and location, and various other filters such as 'country', 'region', 'city', 'department', 'language', 'releasedAfter', and 'customField'. The response includes a list of postings with details such as job ID, name, company information, location, industry, department, employment type, experience level, and visibility.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List All Job Applications

  • ID: get_list_all_job_applications
  • Operation:
  • Entities:
  • Summary: This API endpoint lists all job applications by retrieving candidates matching specified criteria from the SmartRecruiters platform. It supports various query parameters for filtering candidates, such as keyword search, job ID, location, status, consent status, and more. The response includes candidate details like ID, name, email, location, and job assignments. Pagination is supported through the 'limit' and 'pageId' query parameters, with links to the next page provided in the response headers. The API returns a JSON object containing the list of candidates and metadata about the search results.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List Departments for a Given Company

  • ID: get_list_departments_for_given_company
  • Operation: read
  • Entities: company, department
  • Summary: This API endpoint retrieves a list of departments for a specified company. The request requires the 'companyIdentifier' as a path parameter, which is mandatory. An optional 'accept-language' header can be provided to specify the language of translation. The response includes the total number of departments found and an array of department objects, each containing an 'id', 'label', and 'description'.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List Interviews

  • ID: get_list_interviews
  • Operation: read
  • Entities: job, candidate, interview
  • Summary: This API endpoint retrieves a list of interviews associated with a specific application ID. The request requires the 'applicationId' as a query parameter, which is a GUID representing the application. The response includes details about each interview, such as the candidate's ID, job ID, location, organizer ID, timezone, and timeslots. Each timeslot contains information about the interview type, title, place, start and end times, interviewers, candidate status, and no-show status. The response also includes metadata like creation time, reference URL, and source. The API returns a 403 error if access is forbidden, a 404 error if the application is not found, and a 500 error for unexpected issues.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get List of Assessment Packages

  • ID: get_list_of_assessment_packages
  • Operation: read
  • Entities: package, assessment, requester
  • Summary: This API endpoint retrieves a list of assessment packages available for recruiters. The request can include optional headers and query parameters to filter the packages based on location and other criteria. The response includes a list of packages, each with details such as id, type, name, description, and assessments. The API supports various response codes, including 200 for successful retrieval, 204 when no packages are available, 400 for invalid requester data, 401 for unauthorized requests, and 403 for requests missing required scopes.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get List of Job Property's Dependents

  • ID: get_list_of_job_property_dependents
  • Operation: read
  • Entities: job property, dependent
  • Summary: This API endpoint retrieves a list of dependents for a specified job property. The request is made using the GET method to the URL 'https://api.smartrecruiters.com/configuration/job-properties/{id}/dependents', where '{id}' is the path parameter representing the job property ID. An optional header 'Accept-Language' can be included to specify the language of the returned content. The response includes a 200 status code with a JSON object containing 'totalFound' and 'content' fields if successful. If access is forbidden, a 403 status code is returned with an error message. If the job property is not found, a 404 status code is returned with an error message.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get List of Job Property's Dependent Values

  • ID: get_list_of_job_propertys_dependent_values
  • Operation: read
  • Entities: job property, job property value, job property dependent
  • Summary: This API endpoint retrieves a list of dependent values for a specific job property's value. It requires the job property ID, the value ID, and the dependent ID as path parameters. Optional query parameters include pageId for pagination and pageSize to specify the number of items per page. The Accept-Language header can be used to specify the language of the returned content. The response includes the total number of found items and an array of content items, each with an ID and label. Possible error responses include 403 Forbidden and 404 Not Found with specific error codes and messages.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Fetch List of Reports

  • ID: get_list_of_reports
  • Operation: read
  • Entities: page, report, filter
  • Summary: This API endpoint is used to fetch a list of reports from the SmartRecruiters reporting API. The reports are sorted by modification date, with newer reports appearing first. The endpoint supports pagination, and the nextPage property in the response can be used to fetch subsequent pages. The response also includes a Link header with a URL to the next page if available. The API accepts query parameters such as 'page' for the page identifier and 'limit' for the number of entities per page, with a default value of 10. The response includes detailed information about each report, including report ID, name, columns, filters, creation and modification dates, and more. The API returns various HTTP status codes, including 200 for success, 400 for invalid parameters, 401 for unauthenticated requests, and 403 for unauthorized requests.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get List of Users

  • ID: get_list_of_users
  • Operation: read
  • Entities: user, language, system role
  • Summary: The Get List of Users API endpoint retrieves a list of users in your company. It supports full-text search queries based on first name, last name, email, and external data. The API allows pagination with a limit on the number of elements returned, and it can filter users updated after a specific date. The response includes user details such as email, first name, last name, system role, language, and more. The API returns a 200 status code with the list of users, a 400 status code for invalid page IDs, and a 403 status code if the user does not have permission to manage users.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List Publications for a Job Ad

  • ID: get_list_publications_for_a_job_ad
  • Operation: read
  • Entities: publication, job, job ad
  • Summary: This API endpoint is used to list publications for a specific job ad. It requires the job ID and job ad ID as path parameters. The request can include optional headers such as 'Accept-Language' to specify the language of the returned content and 'accept' to specify the media type, which defaults to 'application/json'. The query parameter 'activeOnly' can be used to filter publications by their active status, defaulting to 'true'. The response includes a list of publications with details such as source name, type, published and unpublished dates, and posting ID. Possible error responses include 403 for access forbidden and 404 for job ad not found.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Most Recent Report File Details

  • ID: get_most_recent_report_file_details
  • Operation: read
  • Entities: report file, column, report
  • Summary: This API endpoint retrieves the most recent report file details for a specified report using the report ID. It requires at least one successfully generated report file to return a successful response. The request can include an 'If-None-Match' header with a previously retrieved ETag to check if a newer report file is available. If no newer file is available, the API returns a 304 Not Modified status. The response includes details such as report file ID, status, schedule type, generation date, and more. Possible error responses include 400 for invalid report ID, 401 for unauthenticated requests, 403 for unauthorized access, and 404 if no report file is available.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get My User Details

  • ID: get_my_user_details
  • Operation: read
  • Entities: user, location, access group
  • Summary: The 'Get My User Details' API endpoint retrieves the details of the currently authenticated user. It requires an 'accept' header with the value 'application/json'. The response includes user information such as email, first name, last name, system role, external data, SSO identifier, SSO login mode, language, user ID, active status, last updated timestamp, location details, access groups, and seats. The language is specified by a code, and the location includes country, region, city, and coordinates.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get New Hire Details

  • ID: get_new_hire_details
  • Operation: read
  • Entities: new hire
  • Summary: This API endpoint retrieves the details of a new hire using their unique ID. The request requires the 'newHireId' as a path parameter, which is a UUID representing the new hire. The request header must include 'accept: application/json'. The response includes the new hire's ID, first name, last name, email, phone number, and social media details. If the request is unauthorized, a 401 error is returned with an error code and message. If the new hire is not found, a 404 error is returned with an error code and message. A 500 error indicates an unexpected error.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Offer Document

  • ID: get_offer_document
  • Operation: read
  • Entities: document, offer
  • Summary: The Get Offer Document API allows users to retrieve a specific document associated with an offer using the offerId and documentId as path parameters. The request requires an 'accept' header with the value 'application/octet-stream'. The response can be a binary file if successful (HTTP 200) or various error messages in JSON format for different error conditions such as malformed request (HTTP 400), forbidden access due to malware (HTTP 403), not found (HTTP 404), conflict (HTTP 409), or unsupported provider (HTTP 422).
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Offer Documents

  • ID: get_offer_documents
  • Operation: read
  • Entities: provider, document, offer
  • Summary: The Get Offer Documents API retrieves a list of documents related to a specific offer identified by the offerId path parameter. The request requires the 'accept' header to be set to 'application/json'. The response includes a list of documents with their IDs, names, and creation dates, as well as information about whether the documents are currently syncing and the provider (currently only DOCUSIGN is supported). Possible error responses include 400 for malformed requests, 404 if the offer is not found or access is denied, 409 if the offer has not been sent, and 422 if the offer was sent with an unsupported provider.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Offers from SmartRecruiters

  • ID: get_offers_from_smartrecruiters
  • Operation: read
  • Entities: job, candidate, offer
  • Summary: The Get Offers from SmartRecruiters API retrieves a list of job offers based on specified query parameters. The API supports filtering by the number of results to return (limit), the number of results to skip (offset), creation time boundaries (createdAfter and createdBefore), offer age (age), and offer status (status). The response includes the total number of offers found and a list of offer details, including ID, status, creation and update timestamps, and associated actions. If access is denied, a 403 error with a message and error code is returned.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Onboarding Process Assignments

  • ID: get_onboarding_process_assignments
  • Operation: read
  • Entities: onboarding process, assignment, activity assignment
  • Summary: This API endpoint retrieves the assignments associated with a specific onboarding process identified by the onboardingProcessId. The request requires the onboardingProcessId as a path parameter and optionally accepts a query parameter 'integrationRelevant' to filter assignments with an integration key. The response includes arrays of activity assignments, web form assignments, and fillable PDF form assignments, each containing details such as id, title, type, description, and priority indicators. The API returns a 200 status code with the assignments if successful, a 401 status code if unauthorized, a 404 status code if the onboarding process is not found, and a 500 status code for unexpected errors.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Onboarding Process Details

  • ID: get_onboarding_process_details
  • Operation: read
  • Entities: job, onboarding process, new hire
  • Summary: This API retrieves the details of a specific onboarding process using the onboardingProcessId. The request requires the onboardingProcessId as a path parameter and the 'accept' header set to 'application/json'. The response includes the onboarding process details such as id, newHireId, employmentStartDate, jobId, and applicationId if successful (HTTP 200). If the caller is not authorized, a 401 error is returned with an error code and message. If the onboarding process is not found, a 404 error is returned with an error code and message. A 500 error indicates an unexpected error.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Onboarding Status for Candidate

  • ID: get_onboarding_status_for_candidate
  • Operation: read
  • Entities: onboarding status, job, candidate
  • Summary: This API endpoint retrieves the onboarding status for a candidate associated with a given job. It requires the candidate identifier and job identifier as path parameters. The response includes the onboarding status, which can be 'READY_TO_ONBOARD', 'ONBOARDING_SUCCESSFUL', or 'ONBOARDING_FAILED'. In case of errors, it returns appropriate error messages and codes, such as 'NO_ACCESS_TO_CANDIDATE', 'CANDIDATE_NOT_FOUND', 'JOB_NOT_FOUND', 'ONBOARDING_STATUS_NOT_ACTIVE', or 'CANDIDATE_FIELDS_FEATURE_MISSING'.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Partner Configuration

  • ID: get_partner_configuration
  • Operation: read
  • Entities: partner, configuration, assessment
  • Summary: This API endpoint retrieves the configuration details for a partner in the SmartRecruiters system. It requires an 'accept' header with the value 'application/json'. The response includes various URLs related to the partner's API, such as consentUrl, assessmentPackageListUrl, and oauthTokenUrl, among others. It also specifies the consentDisplayMode and supportedAssessmentTypes. The API returns different responses based on the status code: 200 for successful retrieval, 401 for unauthorized requests, 403 for requests missing required scopes, and 404 if the configuration does not exist.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Hiring Team of a Job

  • ID: get_recruiters_assigned_to_a_job
  • Operation: read
  • Entities:
  • Summary: This API endpoint retrieves the hiring team for a specific job identified by the jobId. The request is made using the GET method to the URL https://api.smartrecruiters.com/jobs/{jobId}/hiring-team. The request can include an optional 'Accept-Language' header to specify the language of the returned content. The response includes a list of team members with their roles and actions. If the job access is denied, a 401 error is returned with a message and error details.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Rejection Reasons

  • ID: get_rejection_reasons
  • Operation: read
  • Entities: rejection reason
  • Summary: This API endpoint retrieves the list of rejection reasons from the SmartRecruiters configuration. It uses the GET method and requires the 'accept' header to be set to 'application/json'. The response includes the total number of rejection reasons found and an array of rejection reasons, each with a unique identifier and a label.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Report File Details

  • ID: get_report_file_details
  • Operation: read
  • Entities: file, column, report
  • Summary: This API endpoint is used to retrieve details of a specific report file using its identifier. The request requires the 'reportFileId' as a path parameter and the 'accept' header set to 'application/json'. The response includes detailed information about the report file such as its status, schedule type, generation date, and any associated columns and filters. The API returns different status codes: 200 for a successful response with report details, 401 if the request is not authenticated, 403 if the caller is not authorized, and 404 if the report file with the given ID does not exist.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Fetch Report Files for a Specific Report

  • ID: get_report_files_for_specific_report
  • Operation: read
  • Entities: report file, report, filter
  • Summary: This API endpoint is used to fetch a list of report files for a specific report identified by the reportId path parameter. The report files are sorted by generation date, with newer files appearing first. The API supports pagination through the page query parameter or the Link HTTP header in the response. The limit query parameter specifies the number of entities returned per page, with a default value of 10 and a maximum of 1000. The response includes a nextPage property for pagination, and the content array contains details of each report file, including its status, schedule type, and associated metadata. Error responses include status codes 400, 401, 403, and 404, each with a message and error details.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Review Details

  • ID: get_review_details
  • Operation: read
  • Entities: job, review, candidate
  • Summary: This API endpoint retrieves the details of a specific review using the review ID. The request requires the 'reviewId' as a path parameter, which is a GUID representing the ID of the review. The request header must include 'accept: application/json'. The response includes the review details such as 'id', 'candidateId', 'jobId', 'reviewerId', 'overallRating', 'comment', 'createdOn', and 'updatedOn'. Possible error responses include 400 for invalid review ID, 401 for unauthorized access, 403 for forbidden access, and 404 if the review is not found.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Search Candidate Messages

  • ID: get_search_candidate_messages
  • Operation: read
  • Entities: message, job, candidate
  • Summary: This API endpoint allows users with ADMINISTRATOR role to search for messages related to a specific candidate. The messages can be filtered by job application using the jobId parameter. The API requires the candidateId as a mandatory query parameter, while jobId, pageId, and limit are optional. The response includes an array of messages with details such as content, creation date, visibility, author ID, and context. The response headers may include a Link header for pagination. Possible error responses include 403 for permission issues and 400 for not found errors.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Search Jobs by Parameters

  • ID: get_search_jobs_by_parameters
  • Operation: read
  • Entities: job, department, location
  • Summary: The Search Jobs by Parameters API allows users to search for jobs using various query parameters such as job title, limit, offset, pageId, sort order, city, department, update time, last activity time, language, job status, and posting status. The API returns a list of jobs matching the search criteria, including details such as job ID, title, reference number, creation and update times, department, location, status, posting status, language, and available actions. The response includes pagination support with a nextPageId for retrieving subsequent pages of results.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Single Candidate Source

  • ID: get_single_candidate_source
  • Operation: read
  • Entities: source, source subtype
  • Summary: This API endpoint retrieves a single candidate source for a given type. It requires the 'sourceType' and 'sourceValueId' as path parameters. An optional query parameter 'sourceSubType' can be provided. The response includes details such as 'id', 'label', 'sourceIdentifier', 'sourceSubType', and 'actions'. If the request is successful, a 200 status code is returned with the source details. If there are errors, a 400 or 404 status code is returned with error messages.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

SmartRecruiters Consent Request Endpoint

  • ID: get_smartrecruiters_consent_request_endpoint
  • Operation: read
  • Entities: company, integration, credential
  • Summary: This API endpoint is used by SmartRecruiters to send a request for consent. The partner will create client credentials, retrieve an access token using master client credentials, and send generated credentials using the obtained OAuth token. In return, SmartRecruiters will send client credentials for the company setting up the integration. The request is made using the GET method to the URL 'https://your.domain.com/integration'. It accepts an optional query parameter 'companyId', which is the ID of the company setting up the integration. The response is a page with consent for the customer admin, returned as a string in 'text/html' format.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Specific Report Details

  • ID: get_specific_report_details
  • Operation: read
  • Entities: column, report, filter
  • Summary: This API endpoint is used to retrieve the details of a specific report using the SmartRecruiters Reporting API. The request is made using the GET method to the URL 'https://api.smartrecruiters.com/reporting-api/v201804/reports/{reportId}', where 'reportId' is a required path parameter that identifies the report. The request must include an 'accept' header with the value 'application/json'. The response includes detailed information about the report, such as its ID, name, columns, filters, creation and modification dates, and more. The response can also include error messages for invalid report IDs (400), unauthenticated requests (401), unauthorized access (403), or if the report is not found (404).
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Subscription Details

  • ID: get_subscription_details
  • Operation: read
  • Entities: callback URL, subscription, event
  • Summary: This API endpoint retrieves the details of a specific subscription using its unique identifier. The request requires the 'id' path parameter, which is a UUID representing the subscription identifier. The response includes the subscription details such as 'id', 'callbackUrl', 'events', and 'status'. The 'events' array contains objects with 'name' and 'version' properties, detailing the events the subscription is listening to. The 'status' indicates whether the subscription is 'active' or 'inactive'. If the request is unauthorized, a 403 error is returned with an error message. If the subscription is not found, a 404 error is returned with an error message.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get System Roles

  • ID: get_system_roles
  • Operation: read
  • Entities: user, system role
  • Summary: The Get System Roles API retrieves a list of system roles available in the SmartRecruiters platform. It requires an 'accept' header with the value 'application/json'. The response includes a 200 status code with a list of roles, each having an 'id' and 'name'. If the user does not have permission to manage users, a 403 status code is returned with an error message and code.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get User Details

  • ID: get_user_details
  • Operation: read
  • Entities: user, location, access group
  • Summary: The Get User Details API retrieves detailed information about a user identified by the user ID provided in the path parameter. The request requires an 'accept' header specifying 'application/json'. The response includes user details such as email, first name, last name, system role, language, and location. It also provides information on access groups and seats. If the user is not found, a 404 error is returned. If the requester lacks permission, a 403 error is returned.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Web Form Assignment Answers

  • ID: get_web_form_assignment_answers
  • Operation: read
  • Entities: web form assignment, answer, field
  • Summary: This API endpoint retrieves the answers submitted for a specific Web Form Assignment identified by the 'webFormAssignmentId'. The request requires the 'webFormAssignmentId' as a path parameter and the 'accept' header set to 'application/json'. The response includes the answers with their 'fieldId', 'integrationKey', and 'answerValue'. Possible response codes include 200 for successful retrieval, 401 if the caller is not authorized, 404 if the Web Form Assignment or its answers are not found, and 500 for unexpected errors.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Web Form Assignment Fields Metadata

  • ID: get_web_form_assignment_fields_metadata
  • Operation: read
  • Entities: web form assignment, field
  • Summary: This API endpoint retrieves the metadata of the fields that belong to a single Web Form Assignment. It requires the 'webFormAssignmentId' as a path parameter, which is a UUID representing the ID of the Web Form Assignment. The request must include an 'accept' header with the value 'application/json'. The response includes the fields metadata in a JSON object if successful (HTTP 200), or error messages if the request is unauthorized (HTTP 401), the Web Form Assignment is not found (HTTP 404), or an unexpected error occurs (HTTP 500).
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Webhook Subscriptions

  • ID: get_webhook_subscriptions
  • Operation: read
  • Entities: job, subscription, event
  • Summary: The Get Webhook Subscriptions API retrieves a list of webhook subscriptions from the SmartRecruiters platform. It accepts query parameters such as 'page_id' to identify the next page of subscriptions and 'limit' to specify the number of elements to return, with a default value of 10 and a maximum of 100. The request must include an 'accept' header with the value 'application/json'. The response includes a list of subscription details, each containing an 'id', 'callbackUrl', 'events', and 'status'. The 'events' array lists the events for which the subscription is registered. The response may also include a 'Link' header for pagination. If the request is unauthorized, a 403 error with a list of error codes and messages is returned.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Withdrawal Reasons

  • ID: get_withdrawal_reasons
  • Operation: read
  • Entities: configuration, withdrawal reason
  • Summary: The 'Get Withdrawal Reasons' API endpoint retrieves a list of withdrawal reasons from the SmartRecruiters configuration. It requires an 'accept' header specifying 'application/json' as the media type for the response. The API does not require any path parameters, query parameters, or request body. Upon a successful request, it returns a JSON object containing 'totalFound', which is the total number of withdrawal reasons, and 'content', an array of objects each containing an 'id' and 'label' for the withdrawal reasons. If the request is unauthorized, a 403 response with a message and errors array is returned.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Submit Job Property Translations

  • ID: patch_submit_job_property_translations
  • Operation: write
  • Entities: job property, language, translation
  • Summary: This API endpoint allows users to submit translations for a specific job property identified by the 'id' path parameter. The request must include a JSON array in the body, where each object contains a 'label' and a 'language' code. The 'language' code can be a standard two-letter code or a locale-specific code. The API returns a 204 status code if the translations are accepted. Possible error responses include 400 for invalid input, 403 for forbidden access, 404 if the job property is not found, 409 for duplicate language entries, and 422 for invalid input format.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Submit Job Property Value Translations

  • ID: patch_submit_job_property_value_translations
  • Operation: write
  • Entities: job property, language, translation
  • Summary: This API endpoint allows users to submit translations for a job property's value to different languages. The request requires the job property identifier and the job property's value identifier as path parameters. The request body must include an array of translation objects, each containing a 'label' and a 'language' code. The language code can be a two-letter code or a four-letter code with a locale. The API returns a 204 status code if the translations are accepted. If there are errors, such as forbidden access (403), job property not found (404), or duplicate translations (409), the API returns an appropriate error message.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Assessment Package Results

  • ID: patch_update_assessment_package_results
  • Operation: write
  • Entities: result, assessment, order
  • Summary: The Update Assessment Package Results API allows users to update the results for a package ordered using the PATCH method. It follows RFC 7396 rules to describe a set of modifications. The API requires the 'orderId' as a path parameter, which is a UUID representing the order ID. The request body can include details such as assessment package date, submission date, name, status, score, score label, summary, attachments, and assessment results. The response returns the updated details of the assessment package, including the same fields as the request body. The API handles various response codes, including 200 for successful updates, 400 for invalid updates, 401 for unauthorized requests, 403 for missing required scopes, 404 for non-existent orders, and 415 for unsupported payload formats.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Candidate Details

  • ID: patch_update_candidate_details
  • Operation: write
  • Entities: education, candidate, location
  • Summary: The Update Candidate Details API allows you to update the personal information of a candidate identified by their unique ID. The API endpoint is accessed via a PATCH request to the URL https://api.smartrecruiters.com/candidates/{id}. The request must include headers specifying 'accept' and 'content-type' as 'application/json'. The path parameter 'id' is required to specify the candidate's identifier. The request body can include fields such as firstName, lastName, email, phoneNumber, location, and web details. The response will return a 200 status code with the updated candidate details if successful. If the user does not have permission, a 403 status code with a PERMISSION_DENIED error is returned. If the candidate is not found, a 404 status code with a CANDIDATE_NOT_FOUND error is returned.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Interview Details

  • ID: patch_update_interview_details
  • Operation: write
  • Entities: location, candidate, interview
  • Summary: This API endpoint allows updating the details of an interview identified by the interviewId. The request requires the interviewId as a path parameter and accepts a JSON body containing the interview details to be updated, such as location, timezone, and candidate status. The candidate status is mandatory and can be one of 'accepted', 'declined', 'pending', or 'tentative'. The API returns a 204 status code on successful update, and various error codes for invalid input, forbidden access, or if the interview is not found.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Interview Timeslot

  • ID: patch_update_interview_timeslot
  • Operation: write
  • Entities: timeslot, interviewer, interview
  • Summary: The Update Interview Timeslot API allows users to update the details of a specific interview timeslot. The API requires the interviewId and timeslotId as path parameters. The request body must include the start and end times of the timeslot, as well as a list of interviewers with their statuses. The API returns a 204 status code if the update is successful. Possible error responses include 400 for missing data, 403 for forbidden updates, 404 if the interview or timeslot is not found, 422 for validation errors, and 500 for unexpected errors.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Interview Types

  • ID: patch_update_interview_types
  • Operation: write
  • Entities: interview type
  • Summary: The Update Interview Types API allows users to update the list of interview types by sending a PATCH request to the specified endpoint. The request must include headers specifying 'accept' and 'content-type' as 'application/json'. The body of the request should be an array of strings representing the interview types to be added, with a minimum of 1 and a maximum of 2000 items. Each string can have a maximum length of 400 characters. The API responds with a 204 status code if successful, or error codes such as 403 if forbidden, 409 if the maximum size is exceeded, 422 for input validation failures, and 500 for unexpected errors. The response body for errors includes an array of error objects with 'code' and 'message' fields.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Job Details

  • ID: patch_update_job_details
  • Operation: write
  • Entities: job, department, location
  • Summary: The Update Job Details API allows users to update the details of a job using a PATCH request. The endpoint requires a jobId path parameter to identify the job to be updated. The request headers must include 'accept' and 'content-type' with values 'application/json' and 'application/json-patch+json' respectively. The request body should contain an array of JSON patch operations, each specifying an operation type (add, replace, test, move, copy, remove) and the path to the job attribute to be modified. The response includes a 200 status code with the updated job details, or error codes such as 400, 401, 403, and 422 for various failure scenarios.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Job Headcount

  • ID: patch_update_job_headcount
  • Operation: write
  • Entities: headcount, job, salary range
  • Summary: The Update Job Headcount API allows users to update the headcount for a specific job identified by the jobId path parameter. The request must include a JSON body with the salaryRange object, specifying the minimum and maximum salary and the currency. The API responds with a 202 status indicating the request is pending, or with error messages and codes for invalid requests, such as invalid salary range, permission denied, or approval process not enabled.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Job Property

  • ID: patch_update_job_property
  • Operation: write
  • Entities: job property, organization
  • Summary: The Update Job Property API allows users to update a specific job property by its identifier. The API uses the PATCH method and requires the job property ID as a path parameter. The request body must be a JSON Patch document, which is an array of operations to be applied to the job property. Each operation must specify a path and an operation type (add, replace, test, move, copy, or remove). The response will return the updated job property details if successful, or an error message if the job property is not editable, forbidden, not found, or if the job property name is restricted.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Job Property Value

  • ID: patch_update_job_property_value
  • Operation: write
  • Entities: job property, job property value
  • Summary: This API endpoint allows updating a job property value by sending a PATCH request to the specified URL. The request requires path parameters 'id' and 'valueId' which are the identifiers for the job property and its value respectively. The request body should be a JSON patch operation array, allowing operations like 'add', 'replace', 'move', 'copy', 'remove', and 'test'. The response returns an updated job property value object if successful (HTTP 200), or various error messages for forbidden access (HTTP 403), not found errors (HTTP 404), conflict errors (HTTP 409), and validation errors (HTTP 422).
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update No-Show Status for Interview Timeslot

  • ID: patch_update_no_show_status_for_interview_timeslot
  • Operation: write
  • Entities: interview, timeslot
  • Summary: This API endpoint allows updating the no-show status for a specific interview timeslot. It requires the interview ID and timeslot ID as path parameters, and a boolean value as a query parameter to set the new no-show status. The request must include an 'accept' header with 'application/json'. A successful update returns a 204 status code. If the user is forbidden to change the no-show value, a 403 status code is returned with error details. A 404 status code indicates that the interview or timeslot was not found, and a 500 status code indicates an unexpected error.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Review Details

  • ID: patch_update_review_details
  • Operation: write
  • Entities: reviewer, review
  • Summary: The Update Review Details API allows users to update the details of a specific review identified by the reviewId. The API requires the reviewId as a path parameter and accepts a JSON body containing the reviewerId, overallRating, and comment. The overallRating must be an integer between 1 and 5, and the reviewerId must match a specific pattern. The API returns a 204 status code if the review is successfully updated. Possible error responses include 400 for invalid input, 401 for unauthorized access, 403 for forbidden access, 404 if the review is not found, 422 for input validation failures, and 500 for unexpected errors.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Timeslot No-Show Status

  • ID: patch_update_timeslot_no_show_status
  • Operation: write
  • Entities: timeslot, interview
  • Summary: This API endpoint allows updating the no-show status of a specific timeslot within an interview. It requires the interview ID and timeslot ID as path parameters, and a boolean value as a query parameter to set the new no-show status. The request must include an 'accept' header with 'application/json'. A successful request returns a 204 status code. If the user is forbidden to change the no-show value, a 403 status code is returned with error details. A 404 status code indicates that the interview or timeslot was not found, and a 500 status code indicates an unexpected error.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update User Details

  • ID: patch_update_user_details
  • Operation: write
  • Entities: user, location, access group
  • Summary: The Update User Details API allows updating user information using JSON Patch operations. The API endpoint requires a user identifier as a path parameter. The request body should contain an array of JSON Patch operations, such as 'add', 'remove', 'replace', 'move', 'copy', and 'test', each specifying the operation type, path, and value if applicable. The response includes updated user details, including email, first name, last name, system role, and more. Possible error responses include invalid language, role, location, or user name, permission denied, user not found, and resource already exists.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Add Attachment to Order

  • ID: post_add_attachment_to_order
  • Operation: write
  • Entities: order, attachment
  • Summary: This API endpoint allows users to add an attachment to a specific order identified by the orderId path parameter. The request must include the orderId as a path parameter and the attachment content in multipart/form-data format in the request body. The response will return a 201 status code with the URL of the created attachment if successful. If the request is unauthorized, missing required scopes, or if the order does not exist, appropriate error messages will be returned with status codes 401, 403, and 404 respectively.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Add Hiring Team Member to Job

  • ID: post_add_hiring_team_member_to_job
  • Operation: write
  • Entities: hiring team, job, role
  • Summary: This API endpoint allows you to add a member to the hiring team of a specific job identified by the jobId. The request requires the jobId as a path parameter and a JSON body containing the id and role of the hiring team member. The role must be one of the predefined roles such as HIRING_MANAGER, INTERVIEW_TEAM, RECRUITER, EXECUTIVE, or COORDINATOR. The response will confirm the addition of the team member or provide error messages if the user is not found, access is denied, or the user is already a member of the hiring team.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Add Job Property's Dependent Value

  • ID: post_add_job_property_dependent_value
  • Operation: write
  • Entities: job property, value, dependent value
  • Summary: This API endpoint allows you to add a dependent value to a specific job property's value. It requires the job property identifier, the job property's value identifier, and the job property's dependent identifier as path parameters. The request body must include the identifier of the job property's dependent value. The API returns a 204 status code on success. In case of errors, it returns appropriate error messages with codes such as JOB_PROPERTY_DEPENDENT_VALUE_NOT_FOUND, JOB_PROPERTY_NOT_FOUND, JOB_PROPERTY_VALUE_NOT_FOUND, JOB_PROPERTY_DEPENDENT_NOT_FOUND, DEPENDENCY_NOT_FOUND, and JOB_PROPERTY_DEPENDENT_VALUE_EXISTS.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Add Tags to Candidate

  • ID: post_add_tags_to_candidate
  • Operation: write
  • Entities: tag, candidate
  • Summary: This API endpoint allows you to add new tags to a specified candidate without replacing existing tags. The request requires the candidate's identifier as a path parameter and a JSON body containing an array of tags to be added. The tags array can contain up to 100 strings, each with a maximum length of 50 characters. The response will return a 201 status code with the added tags if successful. If there are too many tags, a 400 status code is returned with an error message. If the user does not have permission to access the candidate, a 403 status code is returned with an error message.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Add Users to Access Group

  • ID: post_add_users_to_access_group
  • Operation: write
  • Entities: user, access group
  • Summary: This API endpoint allows adding users to a specified access group by providing an array of user IDs. The request requires the 'accessGroupId' as a path parameter and accepts a JSON array of user IDs in the request body. The response can be a 201 status code indicating successful addition of users, or error codes 400, 403, or 404 indicating various issues such as permission denial or non-existent users or access groups.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Approve Approval Request Decision

  • ID: post_approve_approval_request_decision
  • Operation: write
  • Entities: approver, error, approval request
  • Summary: This API endpoint is used to approve a decision for a specific approval request in the SmartRecruiters system. The request requires the approvalRequestId as a path parameter and the approverId in the request body. The headers must include 'accept' and 'content-type' set to 'application/json'. A successful request will approve the decision, while errors may occur if the approval request is not found, already completed, or if the approver is not allowed to take the decision. The response will include error codes and messages in case of failure.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Attach File to Candidate for a Specific Job

  • ID: post_attach_file_to_candidate_for_a_specific_job
  • Operation: write
  • Entities: candidate, job, attachment
  • Summary: This API endpoint allows you to attach a file to a candidate in the context of a specific job. The request requires the candidate's ID and the job ID as path parameters. The request body must include the attachment type, which can be 'GENERIC_FILE', 'RESUME', or 'COVER_LETTER', and the file to be uploaded in binary format. The response will return a 201 status code with details of the attachment if successful. Possible error responses include 400 for file issues, 403 for permission denial, 404 if the job is not found, and 422 if the attachment limit is exceeded.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Attach File to Candidate in Job Context

  • ID: post_attach_file_to_candidate_in_job_context
  • Operation: write
  • Entities: job, attachment, candidate
  • Summary: This API endpoint allows you to attach a file to a candidate in the context of a given job. The request requires the candidate identifier and job identifier as path parameters. The request body must include the attachment type, which can be 'GENERIC_FILE', 'RESUME', or 'COVER_LETTER', and the file to be uploaded in binary format. The response will return a 201 status code with details of the attachment if successful. Possible error responses include 400 for file issues, 403 for permission issues, 404 if the job is not found, and 422 if the attachment limit is exceeded.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Post Comment on Approval Request

  • ID: post_comment_on_approval_request
  • Operation: write
  • Entities: user, comment, approval
  • Summary: This API endpoint allows users to post a comment on a specific approval request identified by the 'approvalRequestId'. The request requires a JSON body containing 'content' and 'authorId'. The response will return a 201 status code with the created comment details if successful. Possible error responses include 400 for illegal characters in the comment, 401 for unauthorized access, and 404 if the approval request is not found.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create a New Job

  • ID: post_create_a_new_job
  • Operation: write
  • Entities: job, department, location
  • Summary: The Create a New Job API allows users to create a new job posting on the SmartRecruiters platform. The API endpoint is accessed via a POST request to 'https://api.smartrecruiters.com/jobs'. The request must include headers specifying 'accept' and 'content-type' as 'application/json'. The request body must contain a JSON object with required fields such as 'title', 'function', 'industry', 'experienceLevel', and 'location'. Optional fields include 'refNumber', 'targetHiringDate', 'department', 'typeOfEmployment', 'eeoCategory', 'template', 'compensation', 'jobAd', and 'properties'. The response will return a 201 status code with details of the created job, including 'id', 'title', 'refNumber', 'createdOn', 'updatedOn', 'department', 'location', 'status', 'postingStatus', 'targetHiringDate', 'industry', 'function', 'typeOfEmployment', 'experienceLevel', 'eeoCategory', 'template', 'creator', 'compensation', 'jobAd', 'properties', and 'actions'. Error responses include 400 for invalid input, 403 for forbidden actions, and 409 for conflicts such as duplicate reference numbers.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create a New Candidate and Assign to a Job

  • ID: post_create_candidate
  • Operation: write
  • Entities: source, job, candidate
  • Summary: This API endpoint allows you to create a new candidate and assign them to a specific job using the job ID. It is crucial to track the candidate's source accurately by including the sourceDetails object in the request body. The request requires the candidate's first name, last name, and email, and optionally includes additional details such as phone number, location, web profiles, tags, education, experience, and source details. The response returns the created candidate's details, including their ID, name, contact information, location, web profiles, education, experience, and job assignments. The API also handles various error responses for invalid source details, permission issues, and non-existent source types.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create Candidate Consent Requests

  • ID: post_create_candidate_consent_requests
  • Operation: write
  • Entities: status, consent request, candidate
  • Summary: This API endpoint is used to create consent requests for candidates. It is a POST request to the URL https://api.smartrecruiters.com/candidates/consent-requests. The request headers must include 'accept' and 'content-type' both set to 'application/json'. The request body must contain a 'content' array with at least one and at most 1000 objects, each having a 'candidate id'. The response will return a list of results for each consent request, with a status of 202 if successfully scheduled or 403 if consent cannot be requested due to missing privacy policy configuration.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create Department

  • ID: post_create_department
  • Operation: write
  • Entities: department
  • Summary: This API endpoint allows the creation of a new department in the system. It requires a POST request to the URL https://api.smartrecruiters.com/configuration/departments with headers specifying 'accept' and 'content-type' as 'application/json'. The request body must include a 'label' for the department, and optionally an 'id', 'description', and 'archived' status. On success, it returns a 201 status with the department details. If a department with the given label already exists, it returns a 400 error with a code 'DEPARTMENT_LABEL_NOT_UNIQUE'.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create Dependencies Between Job Properties

  • ID: post_create_dependencies_between_job_properties
  • Operation: write
  • Entities: job property, dependent
  • Summary: This API endpoint allows the creation of dependencies between job properties. It requires a POST request to the specified URL with a path parameter 'id' representing the job property identifier. The request body must include an array of 'ids' representing the dependent job properties. The response will include the total number of dependent job properties found and their details. Possible error responses include circular dependency errors, already dependent errors, not found errors, and authorization errors.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create Inline Assessment Order

  • ID: post_create_inline_assessment_order
  • Operation: write
  • Entities: company, job, candidate
  • Summary: This API endpoint allows the creation of an inline assessment order. It requires a POST request to the specified URL with headers 'accept' and 'content-type' set to 'application/json'. The request body must include 'assessmentPackageId', 'candidate' details (including 'applicationLanguage', 'email', 'firstName', 'lastName'), 'companyId', 'completedAssessmentCallbackUrl', 'jobId' (deprecated), 'resultCallbackURL', and 'job' details (including 'id'). The response will include a URL to the inline assessment if successful (HTTP 200), or error messages for unauthorized (HTTP 401), forbidden (HTTP 403), or not found (HTTP 404) responses.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create Interview

  • ID: post_create_interview
  • Operation: write
  • Entities: job, candidate, interview
  • Summary: This API endpoint allows the creation of an interview in the SmartRecruiters system. The request requires a POST method to the specified URL with headers indicating 'accept' and 'content-type' as 'application/json'. The request body must include details such as 'candidate', 'jobId', 'organizerId', 'timezone', and 'timeslots'. Each timeslot must specify 'startsOn', 'endsOn', and 'interviewers'. The response will return the created interview details including 'id', 'candidate', 'jobId', 'location', 'organizerId', 'timezone', 'timeslots', 'createdOn', 'refUrl', and 'source'. Possible error responses include 400 for invalid timezone, 403 for forbidden access, 422 for input validation failures, and 500 for unexpected errors.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create Interview Timeslot

  • ID: post_create_interview_timeslot
  • Operation: write
  • Entities: timeslot, interviewer, interview
  • Summary: This API endpoint allows the creation of a new timeslot for a specified interview. The request requires the interview ID as a path parameter and a JSON body containing details about the timeslot, including start and end times, interviewers, and optional fields like interview type, title, and place. The response returns the created timeslot details, including its ID and status. Possible error responses include forbidden access, interview not found, maximum timeslots reached, and validation errors.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create Job Advertisement

  • ID: post_create_job_advertisement
  • Operation: write
  • Entities: job, job ad, location
  • Summary: This API endpoint allows the creation of a job advertisement for a specific job identified by the jobId path parameter. The request must include a JSON body with the job ad details, including the title, language, location, and job ad content such as company description, job description, qualifications, additional information, and optional videos. The response returns the created job ad details, including its ID, title, language, location, job ad content, creation and update timestamps, apply URL, posting status, default status, actions, creator, and visibility. The API supports multiple languages and locales, and the location can be specified as remote.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create Job Position

  • ID: post_create_job_position
  • Operation: write
  • Entities: position, job
  • Summary: This API endpoint allows the creation of a new job position for a specified job ID. The request requires a path parameter 'jobId' which is the identifier for the job. The request body must include 'type', 'positionOpenDate', and 'targetStartDate' as required fields. The 'type' field can be either 'NEW' or 'REPLACEMENT'. Upon successful creation, the API returns a 201 status code with details of the created position including 'id', 'positionId', 'type', 'incumbentName', 'positionOpenDate', 'targetStartDate', 'createdOn', and 'status'. If the request is forbidden, a 403 status code is returned with error details.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create Job Property

  • ID: post_create_job_property
  • Operation: write
  • Entities: job property, job, organization
  • Summary: This API endpoint is used to create a job property in the SmartRecruiters system. The request is made using the POST method to the URL https://api.smartrecruiters.com/configuration/job-properties. The request headers should include 'accept' and 'content-type' set to 'application/json'. The request body must include the 'label', 'category', and 'visible' fields, with 'category' being either 'job' or 'organization'. Optional fields include 'active' and 'required'. Upon successful creation, the API returns a 201 status code with the details of the created job property, including its 'id', 'label', 'category', 'active', 'visible', 'required', and any associated 'actions'. If the request is forbidden, a 403 status code is returned with an error message. If there are issues with the request, such as exceeding job property limits or using a restricted name, a 422 status code is returned.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create Job Property Value

  • ID: post_create_job_property_value
  • Operation: write
  • Entities: job property, value
  • Summary: This API endpoint allows the creation of a job property value in the SmartRecruiters system. The endpoint requires a POST request to the URL https://api.smartrecruiters.com/configuration/job-properties/{id}/values, where {id} is the job property identifier. The request must include headers specifying 'accept' and 'content-type' as 'application/json'. The body of the request should contain a JSON object with the 'label' field as required, and optional 'id' and 'archived' fields. The response will return a 201 status code with the created job property value details if successful. Possible error responses include 400 for invalid values, 403 for forbidden access, 404 if the job property is not found, 409 if a value with the given label already exists, and 422 for invalid value IDs or other validation errors.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create New Approval Request

  • ID: post_create_new_approval_request
  • Operation: write
  • Entities: approver, step, approval request
  • Summary: This API endpoint allows the creation of a new approval request based on an existing approval request identified by the provided baseId. If the base approval request is pending, it will be abandoned. The new request will have a new id, type, decision mode, and steps, all with PENDING statuses and decisions. The request requires headers specifying 'accept' and 'content-type' as 'application/json'. The body must include 'baseId', 'type', 'decisionMode', and 'steps'. The response will return a 201 status with the new approval request details if successful, or error codes 400 or 401 if there are issues such as missing baseId, invalid approver ids, or unauthorized access.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create a New Candidate and Assign to a Talent Pool

  • ID: post_create_new_candidate
  • Operation: write
  • Entities: source, assignment, candidate
  • Summary: This API endpoint allows you to create a new candidate and assign them to a Talent Pool in the SmartRecruiters system. It is crucial to track the candidate's source accurately by including the 'sourceDetails' object in the request body. The request body must include the candidate's first name, last name, and email, and can optionally include additional information such as phone number, location, web profiles, tags, education, and experience. The response will include the candidate's ID, personal details, location, web profiles, tags, education, experience, and assignment details. The API returns a 201 status code upon successful creation, and may return error codes such as SOURCE_NOT_FOUND, SUBTYPE_REQUIRED, PERMISSION_DENIED, or SOURCE_TYPE_NOT_FOUND in case of issues.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create a New Candidate Application

  • ID: post_create_new_candidate_application
  • Operation: write
  • Entities: candidate, attachment, application
  • Summary: This API endpoint allows the creation of a new candidate application for a specific job posting identified by the UUID. The request is made on behalf of a candidate, allowing them to access and edit their data, including attachments. The request requires a path parameter 'uuid' which is the posting UUID. The request body must include the candidate's first name, last name, and email, along with optional details such as phone number, location, web profiles, tags, education, experience, source details, resume, avatar, attachments, answers to questions, a message to the hiring manager, consent, and internal status. The response will return a 200 status code with the candidate's ID and creation date if successful, or an error code and message for various failure scenarios.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create a New Job

  • ID: post_create_new_job
  • Operation: write
  • Entities: location, department, job
  • Summary: This API endpoint allows the creation of a new job in the SmartRecruiters system. The request is made via a POST method to the URL https://api.smartrecruiters.com/jobs. The request headers must include 'accept' and 'content-type' set to 'application/json'. The request body must include a JSON object with required fields such as 'title', 'function', 'industry', 'experienceLevel', and 'location'. Optional fields include 'refNumber', 'targetHiringDate', 'department', 'typeOfEmployment', 'eeoCategory', 'template', 'compensation', 'jobAd', and 'properties'. The response will return a 201 status code with details of the created job, including 'id', 'title', 'refNumber', 'createdOn', 'updatedOn', 'department', 'location', 'status', 'postingStatus', 'targetHiringDate', 'industry', 'function', 'typeOfEmployment', 'experienceLevel', 'eeoCategory', 'template', 'creator', 'compensation', 'jobAd', 'properties', and 'actions'. Error responses include 400 for invalid input, 403 for forbidden actions, and 409 for conflicts such as duplicate reference numbers.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create a New User in SmartRecruiters

  • ID: post_create_new_user
  • Operation: write
  • Entities: user, system role, language
  • Summary: This API endpoint allows you to create a new user in the SmartRecruiters system. The request requires a JSON body with the user's first name, last name, and system role. Optional fields include email, external data, SSO identifier, SSO login mode, language, location, and seats. The response returns the created user's details, including their ID, active status, and location information. Error responses may include codes for invalid language, role, user name, or other properties.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create Package Order

  • ID: post_create_package_order
  • Operation: write
  • Entities: job, order, candidate
  • Summary: This API endpoint allows the creation of a package order. It requires a POST request to the URL https://your.domain.com/packages/orders with headers specifying 'accept' and 'content-type' as 'application/json'. The request body must include details such as 'assessmentPackageId', 'candidate' information, 'companyId', 'jobId', 'resultCallbackURL', and 'job' details. The 'jobId' is marked as deprecated. The response can be a 202 status for order acceptance, or error responses with status codes 401, 403, or 404, each providing an array of error objects with 'code' and 'message'.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create a Review

  • ID: post_create_review
  • Operation: write
  • Entities: job, review, candidate
  • Summary: This API endpoint allows the creation of a review for a candidate related to a specific job. The request requires a JSON body with the candidateId, jobId, and overallRating as mandatory fields. Optional fields include reviewerId, comment, and createdOn. The response will return a 201 status code with the details of the created review if successful. Errors such as 401, 403, and 422 may occur due to authorization issues or input validation failures.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create a Review for a Candidate

  • ID: post_create_review_for_candidate
  • Operation: write
  • Entities: review, job, candidate
  • Summary: This API endpoint allows the creation of a review for a candidate. It requires a POST request to the specified URL with headers 'accept' and 'content-type' set to 'application/json'. The request body must include 'candidateId', 'jobId', and 'overallRating' as required fields, with optional fields 'reviewerId', 'comment', and 'createdOn'. The response will return a 201 status code with the created review details if successful. Possible error responses include 401 for unauthorized access, 403 for forbidden actions, 422 for validation errors, and 500 for unexpected errors.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create SINGLE_SELECT Candidate Property Value

  • ID: post_create_single_select_candidate_property_value
  • Operation: write
  • Entities: value, candidate property
  • Summary: This API endpoint allows the creation of a SINGLE_SELECT candidate property value. The request requires a path parameter 'id' which is the candidate property identifier. The request body must include a 'label' which is a string with a minimum length of 1 and a maximum length of 1000. The response will return a 201 status code with the created candidate property value if successful. Error responses include 400 for invalid candidate property type or exceeded values limit, 404 if the candidate property is not found, and 409 if a candidate property with the given id or label already exists.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create User in SmartRecruiters

  • ID: post_create_user_in_smartrecruiters
  • Operation: write
  • Entities: user, language, system role
  • Summary: This API endpoint allows the creation of a new user in the SmartRecruiters system. The request must include the user's first name, last name, and system role. Optional fields include email, external data, SSO identifier, SSO login mode, language, location, and seats. The response will return the created user's details, including their ID, active status, and location information. Error responses include invalid input, permission denied, user already exists, and invalid request body.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create Webhook Subscription

  • ID: post_create_webhook_subscription
  • Operation: write
  • Entities: subscription, webhook, event
  • Summary: This API endpoint allows users to create a webhook subscription for various events in the SmartRecruiters platform. The request requires a callback URL and a list of events to subscribe to. Optional parameters include an alerting email address and callback authentication details. The response includes the subscription ID, callback URL, events, and status. The API limits the number of subscriptions per user or OAuth application to 20. The response can return different status codes indicating success or various errors, such as invalid request parameters or exceeded subscription limits.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Entity Mappings by Entity Name and Configuration IDs

  • ID: post_entity_mappings_by_entity_name_and_configuration_ids
  • Operation: read
  • Entities: configuration, entity mapping
  • Summary: [BETA] This API endpoint retrieves entity mappings based on the provided entity name and configuration IDs. The request requires the entity name as a path parameter and a list of configuration IDs in the request body. The response will include the entity mappings if the request is successful (HTTP 200) or an error message if access is forbidden (HTTP 403).
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Entity Mappings by Entity Name and Entity IDs

  • ID: post_entity_mappings_by_entity_name_and_entity_ids
  • Operation: read
  • Entities: entity id, entity name, entity mapping
  • Summary: [BETA] This API endpoint allows users to retrieve entity mappings by specifying an entity name and a list of entity IDs. The request is made via a POST method to the specified URL, with the entity name provided as a path parameter and the entity IDs included in the request body as an array of strings. The response will return a 200 status code with a list of mappings if successful, or a 403 status code if access is forbidden due to authorization issues. The response body for a successful request includes an array of objects, each containing an 'entityId' and a 'configurationId'. In case of a 403 error, the response body includes a message and an array of error objects, each with a 'code' and 'message'.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Entity Mappings by Entity Name and Entity IDs

  • ID: post_entity_mappings_by_entity_name_and_ids
  • Operation: read
  • Entities: entity id, entity mapping, entity name
  • Summary: [BETA] This API endpoint retrieves entity mappings based on the provided entity name and a list of entity IDs. The request requires a path parameter 'entityName' which specifies the name of the entity. The request body should contain an array of 'entityIds' for which the mappings are to be retrieved. The response will return a 200 status code with a list of mappings if successful, or a 403 status code if access is forbidden due to authorization issues. The response includes the 'entityId' and 'configurationId' for each mapping.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Exchange Credentials for Access Token

  • ID: post_exchange_credentials_for_access_token
  • Operation: write
  • Entities: token, access token, credential
  • Summary: This API endpoint is used by SmartRecruiters to exchange credentials received from a Partner for an access token. The request is made using the POST method to the URL https://your.domain.com/oauth/token. The request headers must include 'accept' set to 'application/json' and 'content-type' set to 'application/x-www-form-urlencoded'. The request body must contain 'grant_type' set to 'client_credentials', along with 'client_id' and 'client_secret'. The response will be a JSON object containing an 'access_token' and 'expires_in' if successful (HTTP 200), or an error message if there is an issue (HTTP 400).
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Generate Ad-hoc Report

  • ID: post_generate_ad_hoc_report
  • Operation: write
  • Entities: file, report, filter
  • Summary: This API endpoint is used to generate an ad-hoc report. The report files are generated asynchronously, and the status of the report file should be checked to be 'COMPLETED' before fetching the data. To check the report file status, use the GET /reports/{reportId}/files/recent endpoint. The request requires the 'reportId' as a path parameter and the 'accept' header set to 'application/json'. The response includes various details about the report file, such as 'reportFileId', 'reportId', 'reportFileStatus', 'scheduleType', 'schedulingDate', 'generationDate', 'requestorId', 'accessGroupId', 'systemRoleId', 'rowEntityTypeId', 'rowEntityInstanceId', 'columns', 'filters', and 'errorReason'. The response can also return error messages for various HTTP status codes like 400, 401, 403, 404, and 409, each with a message and an array of errors.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Generate Secret Key for Subscription

  • ID: post_generate_secret_key_for_subscription
  • Operation: write
  • Entities: webhook, secret key, subscription
  • Summary: This API endpoint allows you to generate a secret key for a subscription, which can be used to verify the author of callback messages. When a new secret key is created, the old one becomes deprecated but remains active for 24 hours. You can have up to 16 non-expired secret keys. The endpoint requires a subscription identifier as a path parameter. The response includes a generated secret key if successful, or error messages if there are issues such as lack of permission or exceeding the secret key limit.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Parse Resume and Create Candidate in Talent Pool

  • ID: post_parse_resume_create_candidate
  • Operation: write
  • Entities: talent pool, candidate, resume
  • Summary: This API endpoint allows you to parse a resume, create a candidate, and assign them to a Talent Pool. The request is made via a POST method to the URL https://api.smartrecruiters.com/candidates/cv. The request headers must include 'accept: application/json' and 'content-type: multipart/form-data'. The body of the request should contain the resume file to be parsed, along with optional parameters such as sourceTypeId, sourceSubTypeId, sourceId, and internal to specify the candidate's source and whether they are a company employee. Upon successful creation, the API returns a 201 status code with detailed candidate information including personal details, location, web presence, education, experience, and assignments. In case of errors, the API returns appropriate error messages with status codes 400, 403, or 404, indicating issues such as unparsable resumes, permission denial, or non-existent source types.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Publish Job Ad to Internal Sources and Aggregators

  • ID: post_publish_job_ad
  • Operation: write
  • Entities: job, posting, job ad
  • Summary: This API endpoint publishes a job ad to internal sources such as Career Pages, Job Widget, Facebook App, WordPress Plugin, and Posting API, and optionally to all free job aggregators. By default, it is set to publish to job aggregators. The API reflects the Publish action available in the SmartRecruiters UI. The internal sources depend on a company's payment plan. The request requires the jobId and jobAdId as path parameters. The request body can include 'aggregators' to specify if the job should be published to aggregators and 'visibility' to set the job ad's visibility as either PUBLIC or INTERNAL. The response can return a status of PENDING if successful, or various error messages if there are issues such as reaching the published job ad limit, unauthorized access, or if the job ad is not found.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Reject Approval Request Decision

  • ID: post_reject_approval_request_decision
  • Operation: write
  • Entities: approver, comment, approval request
  • Summary: This API endpoint is used to reject an approval request decision. It requires the approval request identifier as a path parameter and a JSON body containing the approver's ID and a comment. The request headers must include 'accept' and 'content-type' set to 'application/json'. A successful rejection returns a 204 status code. Errors may include 400 or 404 status codes with detailed error messages.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Send Activation Email to User

  • ID: post_send_activation_email_to_user
  • Operation: write
  • Entities: user, activation email
  • Summary: This API sends an activation email to a user with a given ID. Users created via the API are not active by default. This method provides an alternative to directly activating a user by sending an activation email. The user must open the link in the email and follow the instructions to activate their account. The request requires the 'accept' header to be set to 'application/json' and the 'id' path parameter to specify the user identifier. The response can be a 204 status code indicating success, or error responses such as 403 for permission denied, 404 for user not found, and 422 for activation email unavailable if the user is already activated or deactivated.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Send Password Recovery Instruction

  • ID: post_send_password_recovery_instruction
  • Operation: write
  • Entities: password, email, user
  • Summary: This API sends password recovery instructions to the email address associated with a user identified by the given id. The password will not be reset until the user creates a new password. The request requires the 'accept' header to be set to 'application/json' and the 'id' path parameter to specify the user identifier. The response includes a 204 status code if the email is successfully sent, or error responses with codes such as USER_DISABLED, USER_LOCKED, USER_EMAIL_INVALID, PASSWORD_AUTHENTICATION_DISABLED, or User not found.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Set Up Integration for Company

  • ID: post_set_up_integration_for_company
  • Operation: write
  • Entities: partner, company, credential
  • Summary: This API endpoint is used to set up an integration for a company. It validates if the token has the client_credentials_write scope and if the company has given consent for integration with the partner. It saves the credentials sent by the partner and creates credentials for the current company, which are then sent back to the partner. The request requires a path parameter 'companyId' and a request body containing 'clientId' and 'clientSecret'. The response can be a successful creation of credentials or various error messages indicating issues such as invalid request body, unauthorized request, missing required scopes, or existing integration.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Share Message with Users and Teams

  • ID: post_share_message_with_users_and_teams
  • Operation: write
  • Entities: user, message, candidate
  • Summary: This API endpoint allows users to share messages with specific users, hiring teams, or everyone in a company. The request body requires a 'content' field for the message text, and optional fields such as 'correlationId' for additional ID reference, and 'shareWith' for specifying visibility options. The 'shareWith' object can include 'users' (an array of user IDs), 'hiringTeamOf' (an array of job IDs), 'everyone' (a boolean to share with all company members), and 'openNote' (a boolean to share with those having access to tagged candidates). The response returns a 201 status with an 'id' and 'shareRequired' flag if successful, or a 400 status with error codes for various issues such as invalid visibility options or non-existent users.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Activate Job Property

  • ID: put_activate_job_property
  • Operation: write
  • Entities: job property
  • Summary: This API endpoint is used to activate a job property with a given identifier. The request is made using the PUT method to the URL 'https://api.smartrecruiters.com/configuration/job-properties/{id}/activation'. The 'id' path parameter is required and represents the job property identifier. The request header can optionally include 'accept: application/json'. The API does not require a request body. The possible responses include a 204 status code for successful activation, a 403 status code if access is forbidden due to authorization issues, a 404 status code if the job property is not found, and a 409 status code if there are no active values for the job property. The error responses include a message and an array of errors with codes and messages.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Activate User

  • ID: put_activate_user
  • Operation: write
  • Entities: user
  • Summary: This API endpoint is used to activate a user with a given ID. Users created via the API are initially inactive, and this method allows them to be activated so they can sign in immediately. The request requires the user ID as a path parameter and accepts an optional 'accept' header to specify the response media type. The response can be a 204 status code indicating successful activation, or various error codes such as 400 for invalid user properties, 403 for permission issues, 404 if the user is not found, and 409 for conflicts when activating a user with an email already associated with an active account.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Activate Webhook Subscription

  • ID: put_activate_webhook_subscription
  • Operation: write
  • Entities: subscription, webhook, server
  • Summary: This API endpoint is used to activate a webhook subscription by performing an initial handshake to ensure the target server is ready to consume notifications. The request is made to the specified subscription ID with a PUT method. The path parameter 'id' is required and should be a valid UUID representing the subscription identifier. The request header should include 'accept: application/json'. Upon activation, a POST request is made to the callback URL with an 'X-Hook-Secret' header. The server must respond within 20 seconds with an HTTP 200 response containing the same 'X-Hook-Secret' header. The possible responses include a 204 status for successful activation, a 404 status if the subscription is not found, a 409 status if the subscription is already activated, and a 424 status if the webhook activation handshake fails. Error responses include an array of error objects with 'code' and 'message'.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Archive Job Property Value

  • ID: put_archive_job_property_value
  • Operation: write
  • Entities: job property, archive value
  • Summary: This API endpoint is used to archive a job property value. It requires the job property identifier and the job property's value identifier as path parameters. The request does not require a body or specific headers, but it can accept 'application/json' as a response format. The API responds with a 204 status code on success, indicating that the job property value has been archived. If the user does not have the necessary permissions, a 403 status code is returned with a message and error details. If the job property or its value is not found, a 404 status code is returned with appropriate error messages.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Interviewer's Status for a Timeslot

  • ID: put_interviewers_status
  • Operation: write
  • Entities: timeslot, user, interview
  • Summary: This API endpoint updates the status of an interviewer for a specific timeslot in an interview. It requires the interview ID, timeslot ID, and user ID as path parameters. The request body must include the new status of the interviewer, which can be 'accepted', 'declined', 'pending', or 'tentative'. The API returns a 204 status code if the status is successfully changed. If the user is forbidden to change the status, a 403 error is returned with details. Other possible errors include 404 for not found resources and 422 for input validation failures.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Save Partner's Configuration

  • ID: put_save_partners_configuration
  • Operation: write
  • Entities: partner, configuration, assessment type
  • Summary: This API endpoint is used to save the partner's configuration in the SmartRecruiters system. The request requires a JSON body with several required fields, including URLs for various partner API endpoints, consent display mode, and supported assessment types. The consent display mode can be either REDIRECT or POPUP, determining how end users interact with the consent URL. The response will confirm the configuration with the same fields provided in the request. If the configuration is invalid, unauthorized, or missing required scopes, appropriate error messages will be returned.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Set Candidate Properties for Job

  • ID: put_set_candidate_properties_for_job
  • Operation: write
  • Entities: property, job, candidate
  • Summary: This API endpoint allows setting candidate properties values for a specific job. The endpoint requires the candidate ID and job ID as path parameters. The request body should contain an array of property objects, each with an 'id' and a 'value'. The value can be of various types such as BOOLEAN, COUNTRY, CURRENCY, DATE, NUMBER, PERCENT, REGION, SINGLE_SELECT, TEXT, or USER, depending on the property type. The API returns a 204 status code if the properties are successfully updated. In case of errors, it returns detailed error messages with codes such as COUNTRY_NOT_FOUND, REGION_NOT_FOUND, USER_NOT_FOUND, etc.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Set Candidate Properties Values for Job

  • ID: put_set_candidate_properties_values_for_job
  • Operation: write
  • Entities: property, job, candidate
  • Summary: This API endpoint allows setting candidate properties values for a specific job. It requires the candidate identifier and job identifier as path parameters. The request body should contain an array of property objects, each with a required 'id' and an optional 'value'. The value can be of various types such as boolean, string, number, or object, depending on the property type. The API returns a 204 status code on successful update, and various error codes with descriptions for different failure scenarios, such as COUNTRY_NOT_FOUND, REGION_NOT_FOUND, USER_NOT_FOUND, etc.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Set Onboarding Status for Candidate

  • ID: put_set_onboarding_status_for_candidate
  • Operation: write
  • Entities: onboarding status, job, candidate
  • Summary: This API sets the onboarding status for a candidate associated with a given job. It requires the candidate ID and job ID as path parameters. The request body must include the onboarding status, which can be 'READY_TO_ONBOARD', 'ONBOARDING_SUCCESSFUL', or 'ONBOARDING_FAILED'. The API returns a 204 status code if successful. If there are errors, such as no access to the candidate or the candidate/job not found, it returns a 403 or 404 status code with detailed error messages.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Candidate Property Value Label

  • ID: put_update_candidate_property_value_label
  • Operation: write
  • Entities: candidate property value, candidate property
  • Summary: This API endpoint updates the label of a candidate property value. It requires the candidate property identifier 'id' and the candidate property's value identifier 'valueId' as path parameters. The request body must include a 'label' field with the new label for the candidate property value. The API returns a 201 status code with the updated 'id' and 'label' if successful. Possible error responses include 400 for invalid operations, 404 if the candidate property or value is not found, and 409 if the label already exists.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Updated 7 days ago