SmartRecruiters
API integration

list_all_smart_recruiters_jobs

Search SmartRecruiters jobs by title, department, location, status, and other filters. Returns: id, title, refNumber, createdOn, updatedOn, lastActivityOn, department, location, status, postingStatus, targetHiringDate, hiringProcessId, industry, function. Max 100 per page; returned locations omit latitude and longitude.

get_single_smart_recruiters_job_by_id

Get the full content of a SmartRecruiters job by id. Returns the complete job including id, title, refNumber, department, location, compensation, hiringProcessId, and status. Required: id.

smart_recruiters_jobs_approval

Get the latest approval request for a SmartRecruiters job. Returns: approvalRequestId, positions, salaryRange. Required: job_id.

smart_recruiters_jobs_hiring_team

Get the hiring team of a SmartRecruiters job. Returns team members with id, role, and available actions. Required: job_id.

smart_recruiters_jobs_job_ads

List the job ads of a SmartRecruiters job. Returns: id, title, language, location, compensation, jobAd, createdOn, updatedOn, applyUrl, postingStatus, actions, creator, visibility. Required: job_id.

smart_recruiters_jobs_job_ad_postings

List publications for a SmartRecruiters job ad. Returns: sourceName, type, publishedOn, unpublishedOn, postingId. Required: job_id, job_ad_id.

smart_recruiters_jobs_positions

List positions for a SmartRecruiters job. Returns: id, positionId, type, incumbentName, positionOpenDate, targetStartDate, createdOn, status, hiringManagerId. Required: job_id.

smart_recruiters_jobs_status_history

List status changes for a SmartRecruiters job. Returns: changedOn, status, actions. Required: job_id.

create_a_smart_recruiters_job

SmartRecruiters: Create a new job. Create a new job. Ignores all nonexistent job properties and job properties values.

smart_recruiters_jobs_partial_update

SmartRecruiters: Update a job. Update a job per JSON Merge Patch specification (RFC 6902). The endpoint ignores all absent job properties. - updating of a field might trigger job approval - modification date is changed - all validations rules are applied for required fields and… Required: job_id.

update_a_smart_recruiters_job_by_id

SmartRecruiters: Updates job. Enables you to update job and it's jobAd. This operation requires passing a job id within path and job's new state within body of the PUT request. Ignores all nonexistent job properties and job properties values. However jobAd and all it's properties need to… Required: id.

list_all_smart_recruiters_candidates

Search SmartRecruiters candidates matching all specified filters; only candidates with at least one job application are returned. Returns: id, internal, firstName, lastName, email, phoneNumber, location, web, createdOn, updatedOn, tags, averageRating, education, experience, primaryAssignment, secondaryAssignments, actions. Max 100 per page.

get_single_smart_recruiters_candidate_by_id

Get a single SmartRecruiters candidate by id. Returns the candidate profile including id, firstName, lastName, email, phoneNumber, location, and education. Required: id.

smart_recruiters_candidates_list_attachments

List a SmartRecruiters candidate's attachments in the context of a given job. Returns: id, name, type, contentType, actions. Required: candidate_id, job_id.

smart_recruiters_candidates_download_attachment

Download a candidate's attachment file from SmartRecruiters by its id. Returns the attachment file itself as a binary download (not a JSON object). Required: attachment_id.

smart_recruiters_candidates_get_application

Get a SmartRecruiters candidate's application to a specific job. Returns: applicationId, status, subStatus, startsOn, source, reasonOfRejection, reasonOfWithdrawal, actions, url. Required: candidate_id, job_id.

smart_recruiters_candidates_update_status

Update a candidate's status in SmartRecruiters for a given job assignment. Returns an empty 204 response on success. Required: candidate_id, job_id, status. For statuses that require them, also supply subStatus and reason in the body.

smart_recruiters_candidates_consent

Get a SmartRecruiters candidate's latest consent status. Returns: date, status. Required: candidate_id.

smart_recruiters_candidates_consents

List a SmartRecruiters candidate's consent decisions under the single or separated consent approach. Returns: decisions, recentPendingRequestCreatedOn. Required: candidate_id.

smart_recruiters_candidates_job_status_history

Get a SmartRecruiters candidate's status history for a specific job. Returns history entries with changedOn, status, subStatus, and actions. Required: candidate_id, job_id.

smart_recruiters_candidates_job_properties

Get candidate property values for a candidate's job in SmartRecruiters. Returns: id, key, label, type, value, valueLabel, selectedValueLabels, actions. Required: candidate_id, job_id.

smart_recruiters_candidates_screening_answers

List the screening answers a candidate submitted for a specific job in SmartRecruiters. Returns: id, type, category, name, label, records. Required: candidate_id, job_id.

smart_recruiters_candidates_job_offers

List the offers extended to a candidate for a specific job in SmartRecruiters. Returns the offers (id, status, createdOn, updatedOn, properties). Required: candidate_id, job_id.

create_a_smart_recruiters_candidate

Create a new SmartRecruiters candidate and assign them to a Talent Pool. Returns the created candidate including id, firstName, lastName, email, createdOn, and tags. Required: firstName, lastName, email. Omitting sourceDetails defaults the candidate source to API.

delete_a_smart_recruiters_candidate_by_id

Delete a candidate in SmartRecruiters by id. Returns an empty 204 response on success. Required: id.

update_a_smart_recruiters_candidate_by_id

Update a SmartRecruiters candidate's personal information by id. Returns the updated candidate with id, firstName, lastName, email, location, and updatedOn. Required: id. The email and lastName combination must be unique across candidates.

list_all_smart_recruiters_company

Get company information for your SmartRecruiters account. Returns: identifier, name, location, website, industry, logo, spamStatus.

list_all_smart_recruiters_departments

List departments configured in SmartRecruiters. Returns: id, label, description, archived.

create_a_smart_recruiters_department

Create a new department in SmartRecruiters. Returns the created department with its id, label, description, and archived status. Required: label.

get_single_smart_recruiters_department_by_id

Get a single SmartRecruiters department by id. Returns: id, label, description, archived. Required: id.

list_all_smart_recruiters_interviews

List SmartRecruiters interviews for a given application. Returns: id, candidate, jobId, location, locationType, organizerId, timezone, timeslots, createdOn, refUrl, refId, source. Required: applicationId.

create_a_smart_recruiters_interview

SmartRecruiters: Creates an interview.

delete_a_smart_recruiters_interview_by_id

SmartRecruiters: Deletes an interview. Supported only for interviews created via the Public API. Required: id.

get_single_smart_recruiters_interview_by_id

SmartRecruiters: Retrieves an interview. Interview details Required: id.

smart_recruiters_interviews_partial_update

SmartRecruiters: Modifies an interview. Supported only for interviews created via the Public API. Required: interview_id.

list_all_smart_recruiters_job_publications

List publications for a specific job in SmartRecruiters. Returns: sourceName, type, publishedOn, unpublishedOn, postingId. Required: job_id.

list_all_smart_recruiters_messages

List messages exchanged with a candidate in SmartRecruiters. Returns: content, createdOn, visibility, authorId, context. Required: candidateId.

list_all_smart_recruiters_offers

List SmartRecruiters offers across the company account. Returns offer records from the content array, each including at least its id. No filter parameters are documented in the available source. Max 100 per page.

list_all_smart_recruiters_reviews

List SmartRecruiters reviews for a specific candidate and job. Returns: id, candidateId, jobId, reviewerId, overallRating, comment, createdOn, updatedOn. Required: candidateId, jobId.

create_a_smart_recruiters_review

SmartRecruiters: Creates a review.

delete_a_smart_recruiters_review_by_id

SmartRecruiters: Deletes a review. Required: id, reviewerId.

get_single_smart_recruiters_review_by_id

SmartRecruiters: Retrieves a review. Required: id.

smart_recruiters_reviews_partial_update

SmartRecruiters: Updates a review. Required: review_id.

list_all_smart_recruiters_users

List SmartRecruiters users of your company, with full-text search across names, emails, and external data. Returns: email, firstName, lastName, systemRole, externalData, ssoIdentifier, ssoLoginMode, language, id, active, updatedOn, personIdExternal, accessGroups. Max 100 per page.

smart_recruiters_users_access_groups

List access groups configured in your SmartRecruiters company. Returns: id, name, firstName, lastName, email, active, systemRole, updatedOn, language, ssoLoginMode.

smart_recruiters_users_system_roles

List system roles available in your SmartRecruiters company. Returns: id, name, firstName, lastName, email, active, systemRole, updatedOn, language, ssoLoginMode.

get_single_smart_recruiters_user_by_id

Get details of a specific SmartRecruiters user by id. Returns: email, firstName, lastName, systemRole, externalData, ssoIdentifier, ssoLoginMode, language, id, active, updatedOn, personIdExternal, location, accessGroups. Required: id.

create_a_smart_recruiters_user

Create a new user in SmartRecruiters. Returns the created user including id, firstName, lastName, email, active, and updatedOn. Requires firstName, lastName, and systemRole. Required: firstName, lastName, systemRole.

smart_recruiters_users_partial_update

SmartRecruiters: Update a user. Required: user_id.

list_all_smart_recruiters_candidate_properties

List the candidate properties available in SmartRecruiters. Returns: id, key, label, type, availability, reference, actions.

get_single_smart_recruiters_candidate_property_by_id

Get a candidate property by id in SmartRecruiters. Returns the candidate property definition including its id, key, label, type, availability, reference, and actions. Required: id.

list_all_smart_recruiters_candidate_property_values

List candidate property values for a candidate property in SmartRecruiters. Returns: id, label, externalCode. Required: candidate_property_id. Only selection-type candidate properties (SINGLE_SELECT, MULTI_SELECT) support values.

create_a_smart_recruiters_candidate_property_value

Create a candidate property value in SmartRecruiters. Returns: id, label. Required: candidate_property_id, label.

delete_a_smart_recruiters_candidate_property_value_by_id

Delete a candidate property value label from a selection-type candidate property in SmartRecruiters. Returns an empty 204 response on success. Required: id, candidate_property_id. Cannot remove the last value of a property or values of read-only library properties.

get_single_smart_recruiters_candidate_property_value_by_id

Get a candidate property value by id in SmartRecruiters. Returns: id, label, externalCode. Required: candidate_property_id, id.

update_a_smart_recruiters_candidate_property_value_by_id

Update the label of a candidate property value in SmartRecruiters. Returns: id, label. Required: candidate_property_id, id, label.

list_all_smart_recruiters_hiring_processes

List hiring processes configured in SmartRecruiters. Returns: id, name, active, subStatuses.

get_single_smart_recruiters_hiring_process_by_id

Get a hiring process in SmartRecruiters by id. Returns: id, name, active, subStatuses. Required: id.

list_all_smart_recruiters_job_properties

List the job properties available in SmartRecruiters configuration. Returns: id, label, category, active, visible, required, key, reference, actions.

create_a_smart_recruiters_job_property

Create a job property in SmartRecruiters. Returns the created property including id, label, category, visible, and reference. Required: label, category, visible.

get_single_smart_recruiters_job_property_by_id

Get a job property in SmartRecruiters by id (the job property's id or key). Returns: id, label, category, active, visible, required, key, reference, actions. Required: id.

update_a_smart_recruiters_job_property_by_id

Update a job property in SmartRecruiters by id (the job property's id or key) using a JSON Patch request body. Returns the updated property including id, label, category, visible, and key. Required: id.

list_all_smart_recruiters_job_property_dependents

List the dependents of a SmartRecruiters job property, referenced by its id or key. Returns: id, label, key. Required: job_property_id.

create_a_smart_recruiters_job_property_dependent

Create dependents for a SmartRecruiters job property. Returns: totalFound, content. Required: job_property_id, ids.

delete_a_smart_recruiters_job_property_dependent_by_id

Remove a job property's dependent in SmartRecruiters, deleting the dependency between two job properties. Returns an empty 204 response on success. Required: id, job_property_id.

list_all_smart_recruiters_job_property_values

List available job property values for a job property in SmartRecruiters. Returns: id, label, archived, externalCode. Required: job_property_id.

create_a_smart_recruiters_job_property_value

Create a new job property value for a job property in SmartRecruiters. Returns: id, label, archived. Required: job_property_id, label.

delete_a_smart_recruiters_job_property_value_by_id

Archive a job property value in SmartRecruiters (deprecated endpoint). Returns an empty 204 response on success. Required: job_property_id, id.

smart_recruiters_job_property_values_partial_update

Update a job property value via JSON Patch operations in SmartRecruiters. Returns: id, label, archived. Required: job_property_id, value_id.

update_a_smart_recruiters_job_property_value_by_id

Unarchive a job property value in SmartRecruiters (deprecated endpoint). Returns an empty 204 response on success. Required: job_property_id, id.

list_all_smart_recruiters_job_property_dependent_values

List the dependent values of a SmartRecruiters job property value. Returns: id, label, externalCode. Required: job_property_id, value, dependent_id.

create_a_smart_recruiters_job_property_dependent_value

Add a SmartRecruiters job property's dependent value for a specific parent property value, linking the dependent property's value to the parent value. Returns an empty 204 response on success. Fails if the dependent…. Required: job_property_id, value_id, dependent_id, id.

delete_a_smart_recruiters_job_property_dependent_value_by_id

Remove a SmartRecruiters job property's dependent values relationship, unlinking a dependent property's value from the parent property value. Returns an empty 204 response on success. Required: id, job_property_id, value_id, dependent_id.

list_all_smart_recruiters_offer_properties

List the available offer properties configured in SmartRecruiters. Returns the offer property categories as a collection: each category carries an id and its list of properties, where each property has a key, label, required flag, and type (BOOLEAN, COUNTRY, CURRENCY, DATE, NUMBER, PERCENT, REGION, TEXT, USER, SELECT).

list_all_smart_recruiters_reject_reasons

List the rejection reasons configured for the SmartRecruiters company. Returns: id, label.

list_all_smart_recruiters_sources

List candidate source types with subtypes in SmartRecruiters. Returns: id, label, actions, subtypes.

list_all_smart_recruiters_candidate_sources

List SmartRecruiters candidate sources for a given source type. Returns: id, label, sourceIdentifier, sourceSubType, actions. Required: source_type.

get_single_smart_recruiters_candidate_source_by_id

Get a candidate source in SmartRecruiters by id and source type. Returns: id, label, sourceIdentifier, sourceSubType, actions. Required: source_type, id.

list_all_smart_recruiters_withdrawal_reasons

List the withdrawal reasons configured in SmartRecruiters. Returns each reason's id and label.

list_all_smart_recruiters_interview_types

List the interview types configured in SmartRecruiters. Returns the collection of interview types available for scheduling interviews.

get_single_smart_recruiters_job_application_by_id

Get a SmartRecruiters job application by id. Returns: status, subStatus, sourceIdentifier, createDate, profileId, jobId. Required: id.

list_all_smart_recruiters_job_postings

List active job postings published by a given SmartRecruiters company. Returns: id, uuid, name, jobAdId, defaultJobAd, refNumber, company, releasedDate, location, department, visibility, and 8 more. Required: company_id. Supports full-text q search plus city, department, and language filters. Max 100 per page. Returned location omits lat/long.

get_single_smart_recruiters_job_posting_by_id

Get a SmartRecruiters job posting by id or uuid for a given company. Returns: id, uuid, name, jobId, jobAdId, defaultJobAd, applyUrl, postingUrl, referralUrl, refNumber, company, releasedDate, location, industry, department, function, typeOfEmployment, experienceLevel, customField, visibility, compensation, and 4 more. Required: company_id and id.

list_all_smart_recruiters_me

Get details of the currently authenticated user in SmartRecruiters. Returns: email, firstName, lastName, systemRole, externalData, ssoIdentifier, ssoLoginMode, language, id, active, updatedOn, personIdExternal, location, accessGroups.

create_a_smart_recruiters_approval_approve_decision

Approve an approval request in SmartRecruiters by id. Returns an empty 204 response on success. Required: approval_request_id, approvalRequestId, approverId.

create_a_smart_recruiters_approval_reject_decision

Reject a pending approval request in SmartRecruiters by id on behalf of an approver. Returns an empty 204 response on success. Required: approval_request_id, approvalRequestId, approverId, comment.

create_a_smart_recruiters_approval

Create a SmartRecruiters approval request based on an existing base request; the base request is abandoned if still pending. Returns the new request with id, type, decisionMode, status, and steps. Required: baseId, type, decisionMode, steps.

list_all_smart_recruiters_approvals

List pending SmartRecruiters approval requests where you are an approver. Returns: id, subject, type, decisionMode, status, steps. Max 100 requests per page.

get_single_smart_recruiters_approvals_v_201910_by_id

Get a specific approval request in SmartRecruiters by id. Returns the approval request including its id, subject, type, decisionMode, status, and steps. Required: id.

list_all_smart_recruiters_audit_events

List SmartRecruiters audit events, optionally filtered by time range, event name, author, or entity. Returns a page of events, each including eventName, eventDate, authorType, authorId, entityType, entityId, and a context object with event-specific details. Defaults to the last 7 days when eventDateAfter and eventDateBefore are not provided.

get_single_smart_recruiters_candidate_attachment_by_id

Get the file content of a specific attachment for a SmartRecruiters candidate. Returns the raw attachment binary (file download); no JSON response body is defined for this endpoint. Required: id, candidate_id.

create_a_smart_recruiters_candidate_attachment

Attach a file to a SmartRecruiters candidate via multipart upload. Returns: id, name, type, contentType, actions, limit, nextPageId, content. Required: candidate_id, attachmentType.

list_all_smart_recruiters_candidate_attachments

List all attachments for a SmartRecruiters candidate. Returns: totalFound, content, limit, nextPageId. Required: candidate_id.

delete_a_smart_recruiters_candidate_job_by_id

Delete a candidate's application to a job in SmartRecruiters by its id. Returns an empty 204 response on success. Required: candidate_id, id.

smart_recruiters_candidate_onboarding_status_bulk_update

Set the onboarding status for a SmartRecruiters candidate. Returns an empty 204 response on success. SmartRecruiters deprecates this endpoint in favor of the job-scoped onboarding status endpoint. Required: candidate_id, onboardingStatus.

get_single_smart_recruiters_candidate_onboarding_status_by_id

Get the onboarding status for a candidate in SmartRecruiters. Returns a single-field object: onboardingStatus (one of READY_TO_ONBOARD, ONBOARDING_SUCCESSFUL, ONBOARDING_FAILED). Required: id. Deprecated — use the per-job onboarding status endpoint instead.

smart_recruiters_candidate_status_bulk_update

Update a candidate's status on its primary job assignment in SmartRecruiters. Returns an empty 204 response on success. Required: candidate_id, status. Deprecated: SmartRecruiters recommends using the job-level status update endpoint instead.

get_single_smart_recruiters_candidate_status_by_id

Get a candidate's application status for a specific SmartRecruiters job posting. Returns: status, oauth. Required: id (candidate id), uuid (posting UUID).

delete_a_smart_recruiters_candidates_attachment_by_id

Delete a candidate attachment in SmartRecruiters by id. Returns an empty 204 response on success. Required: id.

create_a_smart_recruiters_candidates_consent_request

Batch-request GDPR consent from multiple candidates in SmartRecruiters. Schedules one consent request per candidate and returns results in request order, each with a status of 202 (scheduled) or 403 (no privacy policy configured). Requires a BatchConsentRequest request body.

create_a_smart_recruiters_candidates_cv

Upload and parse a resume to create a SmartRecruiters candidate and assign them to a Talent Pool. Returns: id, internal, firstName, lastName, email, phoneNumber, location, web, createdOn, updatedOn, tags, experience, primaryAssignment, actions, and 4 more. The resume must be machine-parsable and contain all required candidate details.

create_a_smart_recruiters_candidates_cvs_cv

Create a SmartRecruiters candidate by uploading a resume (CV) and assign them to a job. Returns the created candidate including id, firstName, lastName, email, phoneNumber, and primaryAssignment. Required: job_id.

create_a_smart_recruiters_configuration_access_group

Create a new access group in SmartRecruiters with the given properties and criteria. Returns: id, name, description, criteria. Required: name, description.

get_single_smart_recruiters_configuration_access_group_by_id

Get a single SmartRecruiters access group by id. Returns: id, name, description, criteria, key. Required: id.

list_all_smart_recruiters_configuration_access_groups

List SmartRecruiters access groups with pagination. Returns: id, name, description.

update_a_smart_recruiters_configuration_access_group_by_id

Update a SmartRecruiters access group by id with new properties and criteria. Returns: id, name, description, criteria, key. Required: id, name, description.

delete_a_smart_recruiters_configuration_access_group_by_id

Delete an access group in SmartRecruiters by id. Returns an empty 204 response on success. Required: id.

create_a_smart_recruiters_cv_parse

Parse a resume (CV) in SmartRecruiters and extract structured candidate details from the uploaded document. Returns: firstName, lastName, email, phoneNumber, location, web, education, experience.

create_a_smart_recruiters_integration_company

Enable the SmartRecruiters partner integration for a company by registering partner credentials. Returns the created customer-level credentials: clientId, clientSecret. The company must have consented to the integration. Required: company_id, companyId, clientId, clientSecret.

create_a_smart_recruiters_job_candidate

Create a new candidate and assign them to a job in SmartRecruiters. Returns the created candidate including id, firstName, lastName, email, createdOn, and primaryAssignment. Required: job_id, firstName, lastName, email. Omitting sourceDetails defaults the candidate source to API.

smart_recruiters_job_onboarding_status_bulk_update

Set the onboarding status for a SmartRecruiters candidate on a specific job. Returns an empty 204 response on success. Requires the 'Candidate Fields' feature and an activated Onboarding Status candidate property. Required: candidate_id, job_id, onboardingStatus.

get_single_smart_recruiters_job_onboarding_status_by_id

Get the onboarding status of a candidate associated with a given job in SmartRecruiters. Returns: onboardingStatus, key. Required: id. Available only when the 'Candidate Fields' feature is enabled. The id is the job id; candidate_id is required.

smart_recruiters_job_sources_bulk_update

Update a candidate's source for a job application in SmartRecruiters. Returns an empty 204 response on success. Fails when the source type does not exist, a subtype is required but missing, or the source id does not exist in the provided type. Required: candidate_id, job_id, sourceTypeId, sourceId.

smart_recruiters_order_results_bulk_update

Update the assessment package results of a SmartRecruiters assessment order. Returns: assessmentPackageDate, submissionDate, name, description, status, score, scoreLabel, summary, candidateUrl, attachments, assessmentResults. Required: order_id.

create_a_smart_recruiters_partner_api_integration

Enable a partner integration in SmartRecruiters. Returns: clientId, clientSecret, integrationId. Required: appId, companyId.

smart_recruiters_partner_configurations_bulk_update

Save (bulk update) the SmartRecruiters partner configuration. Returns the stored configuration including consentUrl, consentDisplayMode, oauthTokenUrl, supportedAssessmentTypes, and fields. Required: consentUrl, consentDisplayMode, assessmentPackageListUrl, singleAssessmentPackageUrl, oauthTokenUrl, supportedAssessmentTypes.

list_all_smart_recruiters_partner_configurations

Get the SmartRecruiters partner configuration. Returns: consentUrl, consentDisplayMode, assessmentPackageListUrl, singleAssessmentPackageUrl, packageOrderUrl, inlineAssessmentPackageOrderUrl, oauthTokenUrl, integrationDisableUrl, fields, supportedAssessmentTypes.

create_a_smart_recruiters_posting_candidate

Create a new candidate application for a SmartRecruiters job posting on behalf of the candidate, who can later access and edit their data and attachments. Returns: id, createdOn, applicationId, oauth. Required: uuid, firstName, lastName, email.

get_single_smart_recruiters_posting_configuration_by_id

Get the application configuration for a SmartRecruiters posting, including its screening questions and settings. Returns: questions, settings, privacyPolicies, consentSettings, aiSettings, companyImprintUrl. Required: id, uuid.

create_a_smart_recruiters_results_attachment

Attach a result file to a SmartRecruiters assessment order. Returns the created attachment result including its id and content-type-specific attributes. Adding attachments to inline assessment orders is not supported. Required: order_id, orderId, file.

get_single_smart_recruiters_status_history_by_id

Get a candidate's status history in SmartRecruiters. Returns the history envelope with totalFound and content entries carrying changedOn, status, and subStatus. Required: id. Deprecated — use the candidate's per-job status history endpoint instead.

get_single_smart_recruiters_configuration_career_site_by_id

Get details of a SmartRecruiters career site configuration by id. Returns: id, path, name, published, jobs, language, useCustomSiteUrl, customSiteUrl. Required: id.

list_all_smart_recruiters_configuration_career_sites

List SmartRecruiters career site configurations with pagination. Returns: id, name, path, language, published, useCustomSiteUrl, customSiteUrl.

smart_recruiters_configuration_job_ad_fields_bulk_update

Update the job ad fields configuration for a SmartRecruiters company. Returns the updated configuration including companyId, fields, and updatedAt. Required: fields — the request must contain exactly all currently active fields.

list_all_smart_recruiters_configuration_job_ad_fields

Get the job ad fields configuration for a SmartRecruiters company. Returns: companyId, fields, updatedAt.

smart_recruiters_configuration_predefined_locations_bulk_delete

Bulk-delete predefined locations in SmartRecruiters by supplying an array of their ids. Returns an empty 204 response on success.

create_a_smart_recruiters_configuration_predefined_location

Create a new predefined location in SmartRecruiters. Returns: id, country, region, regionAbbr, countryCode, city, address, postalCode, title, identifier, lat, lng. Required: city, countryCode. Fails when the company's location limit is reached or the title/identifier already exists.

delete_configuration_predefined_location_by_id

Delete a single predefined location in SmartRecruiters by id. Returns an empty 204 response on success. Required: id.

get_configuration_predefined_location_by_id

Get a single predefined location in SmartRecruiters by id. Returns: id, country, region, regionAbbr, countryCode, city, address, postalCode, title, identifier, lat, lng. Required: id.

list_all_smart_recruiters_configuration_predefined_locations

List predefined locations in SmartRecruiters as a paginated list. Returns: id, country, region, regionAbbr, countryCode, city, address, postalCode, title, identifier, lat, lng.

update_configuration_predefined_location_by_id

Update a predefined location in SmartRecruiters by id. Returns the updated location with id, title, identifier, city, countryCode, region, and lat/lng. Required: id, city, countryCode. Title and identifier must be unique.

list_all_smart_recruiters_countrie_custom_scopes

List custom data scopes for a country in SmartRecruiters. Returns the country-specific overrides of custom scopes as a scopes array. Requires the company account to operate on the separated consent model. Required: country_code, countryCode.

create_a_smart_recruiters_countries_custom_scope

Create a custom data scope in SmartRecruiters. Returns: id, countryCode, status, name, checkboxRequired, translations. Requires name, countryCode, checkboxRequired, and translations. The company account must operate on the separated consent model. Required: name, countryCode, checkboxRequired, translations.

delete_a_smart_recruiters_countries_custom_scope_by_id

Delete a custom data scope in SmartRecruiters by id. Returns an empty 204 response on success. Required: id. The company account must operate on the separated consent model.

update_a_smart_recruiters_countries_custom_scope_by_id

Replace an existing custom data scope in SmartRecruiters by id. Returns: id, countryCode, status, name, checkboxRequired, translations. Requires id, name, countryCode, checkboxRequired, and translations. The company account must operate on the separated consent model. Required: id, name, countryCode, checkboxRequired, translations.

list_all_smart_recruiters_dependent_values

Get a dependent job property's values and their correlation to the parent job property in SmartRecruiters. Returns: totalFound, content. Required: job_property_id, dependent_id.

smart_recruiters_job_propertie_activations_bulk_delete

Deactivate a job property in SmartRecruiters by its id or key. Returns an empty 204 response on success. Required: job_property_id.

smart_recruiters_job_propertie_activations_bulk_update

Activate a job property in SmartRecruiters by its id or key. Returns an empty 204 response on success. Required: job_property_id.

delete_a_smart_recruiters_job_propertie_archive_value_by_id

Unarchive a job property value in SmartRecruiters by id. Returns an empty 204 response on success. Fails with VALUE_LABEL_IS_INVALID when the value label contains invalid characters. Required: id, job_property_id.

update_a_smart_recruiters_job_propertie_archive_value_by_id

Archive a job property value in SmartRecruiters by id. Returns an empty 204 response on success. Required: id, job_property_id.

smart_recruiters_job_propertie_translations_bulk_update

Submit translations for a SmartRecruiters job property to multiple languages in a single request. Returns an empty 204 response on success. Required: job_property_id.

smart_recruiters_recruiters_resolves_bulk_update

Resolve a recruiter's name to a source identifier in SmartRecruiters. Useful for looking up the source tracking ID to associate with candidate records. Returns: sourceIdentifier, label, subType, type. Required: sourceName.

list_all_smart_recruiters_sources_configuration

Get a SmartRecruiters candidate source by its identifier. Returns the source's label, type, and subType. Required: source_identifier.

smart_recruiters_value_translations_bulk_update

Submit translations for a SmartRecruiters job property value into different languages. Returns an empty 204 response on success. Required: job_property_id, value_id.

update_a_smart_recruiters_candidates_property_by_id

Set or reset a candidate property value for a candidate in SmartRecruiters. Returns an empty 204 response on success. Required: candidate_id, id. The body's value type depends on the property type; send an empty body to reset the value. Deprecated: use PUT /candidates/{id}/jobs/{jobId}/properties instead.

list_all_smart_recruiters_candidates_properties

Get property values for a SmartRecruiters candidate. Returns: content. Required: candidate_id. Deprecated — use GET /candidates/{id}/jobs/{jobId}/properties instead.

smart_recruiters_candidate_job_properties_bulk_update

Batch-set values for multiple candidate job properties in SmartRecruiters. Requires candidate_id, job_id, and an array of {id, value} items; omit value (or send an empty array for MULTI_SELECT) to reset a property. Returns an empty 204 response on success. Required: candidate_id, job_id.

update_a_smart_recruiters_candidate_job_property_by_id

Deprecated: set a single candidate job property value in SmartRecruiters — use the bulk_update method instead. Requires candidate_id, job_id, and id (the property id); send an empty object to reset the value. Returns an empty 204 response on success. Required: id, candidate_id, job_id.

create_a_smart_recruiters_candidate_tag

Add new tags to a SmartRecruiters candidate without replacing the existing ones. Returns the candidate's tags array. Required: candidate_id, tags.

smart_recruiters_candidate_tags_bulk_update

Replace all of a SmartRecruiters candidate's tags with the provided array. Returns the updated tags array. Required: candidate_id, tags.

smart_recruiters_candidate_tags_bulk_delete

Delete all tags associated with a SmartRecruiters candidate in bulk. Removes every tag on the candidate in a single call. Returns an empty 204 response on success. Required: candidate_id.

list_all_smart_recruiters_candidate_tags

Get the tags assigned to a SmartRecruiters candidate. Returns the candidate's tags array. Required: candidate_id.

create_a_smart_recruiters_approval_comment

Add a comment to a SmartRecruiters approval request. Returns the created comment including its content, authorId, and createdOn. Required: approval_request_id, content, authorId.

list_all_smart_recruiters_approval_comments

List all comments for a SmartRecruiters approval request. Returns: content, authorId, createdOn. Required: approval_request_id.

create_a_smart_recruiters_candidate_job_attachment

Attach a file to a SmartRecruiters candidate in the context of a specific job. Returns: id, name, type, contentType, actions. Required: candidate_id, job_id, attachmentType.

list_all_smart_recruiters_assessment_orders

SmartRecruiters: Retrieves all assessment orders for specified application. Required: applicationId.

list_all_smart_recruiters_events

SmartRecruiters: Get job's events. Use this endpoint to fetch job events. Required: jobId, state.

create_a_smart_recruiters_event

SmartRecruiters: Create event. Use this endpoint to create event.

delete_a_smart_recruiters_event_by_id

SmartRecruiters: Delete event. Use this endpoint to delete event. Required: id.

get_single_smart_recruiters_event_by_id

SmartRecruiters: Get event's details. Use this endpoint to fetch event details. Required: id.

update_a_smart_recruiters_event_by_id

SmartRecruiters: Update event. Use this endpoint to update event Required: id.

create_a_smart_recruiters_events_applicant

SmartRecruiters: Add applicants to event pool. Use this endpoint to add applicants event applicants pool. Required: event_id.

list_all_smart_recruiters_events_applicants

SmartRecruiters: Get all applicants (both event-applicants-pool and session-applicants) for specified event. Use this endpoint to fetch all of the event's applicants. Required: event_id.

list_all_smart_recruiters_events_pool_applicants

SmartRecruiters: Get event's applicants. Use this endpoint to fetch event applicants. Required: event_id.

delete_a_smart_recruiters_events_session_by_id

SmartRecruiters: Delete event's session. Use this endpoint to delete session. Required: id, event_id.

get_single_smart_recruiters_events_session_by_id

SmartRecruiters: Get event's session details. Use this endpoint to get session details. Required: id, event_id.

create_a_smart_recruiters_events_sessions_applicant

SmartRecruiters: Add applicants from event pool to session. Use this endpoint to add applicants to session. Required: event_id, session_id.

smart_recruiters_events_sessions_applicants_bulk_update

SmartRecruiters: Move applicants from session to session. Use this endpoint to move applicants from one session to another. Required: session_id, event_id.

delete_a_smart_recruiters_events_sessions_interviewer_by_id

SmartRecruiters: Remove interviewers from event's session. Use this endpoint to remove interviewers from session. Required: id, event_id.

smart_recruiters_events_sessions_interviewers_bulk_update

SmartRecruiters: Add interviewers to event's session. Use this endpoint to add interviewers to session. Required: session_id, event_id.

get_single_smart_recruiters_events_application_by_id

SmartRecruiters: Get application events. Use this endpoint to fetch application events. Required: id, state.

get_single_smart_recruiters_events_candidate_by_id

SmartRecruiters: Get candidate events. Use this endpoint to candidate events. Required: id, state.

smart_recruiters_interviews_interview_types_bulk_update

SmartRecruiters: Adds interview types to already existing ones.

delete_a_smart_recruiters_interviews_interview_type_by_id

SmartRecruiters: Removes interview type with given name. Required: id.

smart_recruiters_interviews_candidate_status_bulk_update

SmartRecruiters: Changes a candidate's status. Supported only for interviews created via the Public API. Required: interview_id.

create_a_smart_recruiters_interviews_timeslot

SmartRecruiters: Creates a timeslot. Supported only for interviews created via the Public API. Required: interview_id.

delete_a_smart_recruiters_interviews_timeslot_by_id

SmartRecruiters: Deletes a timeslot. Supported only for interviews created via the Public API. Required: id, interview_id.

get_single_smart_recruiters_interviews_timeslot_by_id

SmartRecruiters: Retrieves a timeslot. Supported only for interviews created via the Public API. Required: id, interview_id.

smart_recruiters_interviews_timeslots_partial_update

SmartRecruiters: Modifies a timeslot. Supported only for interviews created via the Public API. Required: interview_id, timeslot_id.

interviews_timeslots_candidate_status_bulk_update

SmartRecruiters: Changes a candidate's status in given timeslot. Supported only for interviews created via the Public API. Required: timeslot_id, interview_id.

interviews_timeslots_interviewers_status_bulk_update

SmartRecruiters: Changes a interviewer's status in given timeslot. Supported only for interviews created via the Public API. Required: interviewer_id, interview_id, timeslot_id.

smart_recruiters_interviews_timeslots_noshow_bulk_update

SmartRecruiters: Changes no-show value in a timeslot. Required: interview_id, timeslot_id, value.

delete_a_smart_recruiters_job_application_by_id

SmartRecruiters: Delete a job application. Delete a job application identified by given job application ID. Required: id.

create_a_smart_recruiters_job_applications_consent_request

SmartRecruiters: Request consent for a job application. Read more about GDPR tools on SmartRecruiters Help Center Required: job_application_id.

list_all_smart_recruiters_job_applications_consents

SmartRecruiters: Get consent decisions. Depending on the consent approach which a customer chooses, the response will either contain one application consent decision - known as "single consent" - or contain one application consent broken out by the data scopes which the customer has subscribed to -… Required: job_application_id.

list_all_smart_recruiters_message_templates

SmartRecruiters: Get Message Templates. Use this endpoint to get Message Templates

create_a_smart_recruiters_message_template

SmartRecruiters: Create Message Template. Use this endpoint to create new Message Template

delete_a_smart_recruiters_message_template_by_id

SmartRecruiters: Remove a message template by id. Use this endpoint to remove message template. Required: id.

get_single_smart_recruiters_message_template_by_id

SmartRecruiters: Get a message template by id. Use this endpoint to fetch a message template. Required: id.

update_a_smart_recruiters_message_template_by_id

SmartRecruiters: Update Message Template. Use this endpoint to update existing Message Template Required: id.

get_single_smart_recruiters_reporting_file_by_id

SmartRecruiters: Get report file. Use this endpoint to get a specific report file details. Required: id.

get_single_smart_recruiters_reporting_files_datum_by_id

SmartRecruiters: Download report file. Use this endpoint to download a specific report file. The response contains report data in CSV format. Note It is not recommended to attempt downloading large report files via Live Docs or Internet Browser. To get a large report file, use command line tools… Required: id.

list_all_smart_recruiters_reporting_reports

SmartRecruiters: Get reports. Use this endpoint to fetch a list of reports. Reports are sorted by modification date (newer reports first). Paging Whenever there's more data to be returned, the nextPage property will contain an opaque identifier of the next page. The value can be then…

get_single_smart_recruiters_reporting_report_by_id

SmartRecruiters: Get report. Use this endpoint to get a specific report details. Required: id.

list_all_smart_recruiters_reporting_reports_files

SmartRecruiters: Get report files. Use this endpoint to fetch a list of report files of a specific report. Report files are sorted by generation date (newer report files first). Paging Whenever there's more data to be returned, the nextPage property will contain an opaque identifier of the… Required: report_id.

create_a_smart_recruiters_reporting_reports_file

SmartRecruiters: Generate ad-hoc report. Use this endpoint to generate ad-hoc report. NOTE: Report files are generated asynchronously. Ensure the report file status is: COMPLETED before fetching the data. To check the report file status use the GET /reports/{reportId}/files/recent endpoint. Required: report_id.

list_all_smart_recruiters_reporting_reports_files_recent

SmartRecruiters: Get most recent report file. Use this endpoint to get the most recent report file details for a specific report. In order to get a successful response, there have to be at least 1 successfully generated report file for the report. Etags Along with the successful response, the Etag HTTP… Required: report_id.

list_all_smart_recruiters_reporting_reports_files_recent_data

SmartRecruiters: Download most recent report file. Use this endpoint to download the most recent report file for a specific report. The response contains report data in CSV format. In order to get a successful response, there have to be at least 1 successfully generated report file for the report. Etags Along… Required: report_id.

get_single_smart_recruiters_reviews_jobs_criterion_by_id

SmartRecruiters: Retrieves all criteria for specified job. Required: id.

list_all_smartonboard_activity_assignments_attachments

SmartRecruiters: Returns list of Attachments submitted for a single Activity Assignment. Required: activity_assignment_id.

list_all_smartonboard_fillable_pdf_form_assignments_form_answers

SmartRecruiters: Returns answers submitted for a single Fillable PDF Form Assignment. Required: fillable_pdf_form_assignment_id.

get_single_smart_recruiters_smartonboard_new_hire_by_id

SmartRecruiters: Returns details for a single New Hire. Required: id.

get_smartonboard_onboarding_process_by_id

SmartRecruiters: Returns details of a single Onboarding Process. Required: id.

list_all_smartonboard_onboarding_processes_assignments

SmartRecruiters: Returns Assignments associated with a single Onboarding Process. Required: onboarding_process_id.

get_smartonboard_web_form_assignments_fields_metadatum_by_id

SmartRecruiters: Returns metadata for the fields that belong to a single Web Form Assignment. Required: id.

list_all_smartonboard_web_form_assignments_form_answers

SmartRecruiters: Returns answers submitted for a single Web Form Assignment. Required: web_form_assignment_id.

create_a_smart_recruiters_access_groups_user

SmartRecruiters: Assign users to access group. Required: access_group_id.

delete_a_smart_recruiters_access_groups_user_by_id

SmartRecruiters: Remove user from access group. Required: id, access_group_id.

delete_a_smart_recruiters_users_activation_by_id

SmartRecruiters: Deactivate a user. Required: id.

smart_recruiters_users_activation_bulk_update

SmartRecruiters: Activate a user. Activate a user with given id. Users created via an API are not active. This method allows activating a user so he/she can sign in straight away. Required: user_id.

create_a_smart_recruiters_users_activation_email

SmartRecruiters: Send an activation email to a user. Send an activation email to a user with given id. Users created via an API are not active. This method is an alternative to activating a user directly and allows sending an activation email in which a user will have to open a link and follow instructions on a… Required: user_id.

smart_recruiters_users_avatar_bulk_update

SmartRecruiters: Update user avatar. Required: user_id.

create_a_smart_recruiters_users_reset_password

SmartRecruiters: Send a password reset email to a user. Send password recovery instruction to the email address associated with a user with a given id. The password will not be reset until the user with a given id creates a new password. Required: user_id.

list_all_smart_recruiters_webhooks_subscriptions

SmartRecruiters: Retrieve webhook subscriptions.

create_a_smart_recruiters_webhooks_subscription

SmartRecruiters: Subscribe to a webhook. Please be aware that before any event is delivered each subscription needs to be activated. See subscription activation. We do limit number of subscriptions each subscriber can register. It means that: individual user can register up to 20 subscriptions OAuth…

delete_a_smart_recruiters_webhooks_subscription_by_id

SmartRecruiters: Delete webhook subscription. Required: id.

get_single_smart_recruiters_webhooks_subscription_by_id

SmartRecruiters: Retrieve single webhook subscription. Required: id.

smart_recruiters_webhooks_subscriptions_activation_bulk_update

SmartRecruiters: Activate a webhook subscription so it starts receiving callbacks. Returns an empty 204 response on success. Required: subscription_id.

list_all_smart_recruiters_webhooks_subscriptions_callbacks_log

SmartRecruiters: Retrieve callback request details starting from the newest. Required: subscription_id.

get_webhooks_subscriptions_secret_key_by_id

SmartRecruiters: Retrieve subscription secret key. Retrieves the last secret key for webhook subscription. Required: id.

create_a_smart_recruiters_webhooks_subscriptions_secret_key

SmartRecruiters: Generate a secret key for a webhook subscription. We allow you to generate a secret key for the subscription. You can use it to verify the author of callback messages. When you have a secret key already defined - a creation of a new one will make the old one deprecated - it will still be active for 24 hours… Required: subscription_id.

get_single_smart_recruiters_candidates_jobs_offer_by_id

SmartRecruiters: Get candidate's offer. Required: id, candidate_id, job_id.

list_all_candidates_jobs_offers_approvals_latest

SmartRecruiters: Get latest approval request for candidate's offer. Required: candidate_id, job_id, offer_id.

list_all_smart_recruiters_feed_publications

SmartRecruiters: Get a list of postings. Get job postings published to your job board. You must pass authentication token through X-SmartToken HTTP header. By default, this endpoint will return only postings created in the last 30 days with the status Pending . Use additional parameters to control…

get_single_smart_recruiters_feed_publication_by_id

SmartRecruiters: Get posting by id. This endpoint allows getting a single job posting information. You must pass authentication token through X-SmartToken HTTP header. Required: id.

update_a_smart_recruiters_feed_publication_by_id

SmartRecruiters: Update posting information. This endpoint allows updating a single job posting status and URL during a job posting lifecycle. You must pass authentication token through X-SmartToken HTTP header. Complete list of body parameters below: Status - This is the posting status on your job… Required: id.

interview_templates_job_templates_partial_update

SmartRecruiters: Patches job level interview template's interviewers pool. Required: job_interview_template_id.

update_a_smart_recruiters_interview_templates_job_template_by_id

SmartRecruiters: Update job level interview template. Updates job level interview template. Required: id.

get_interview_templates_job_templates_job_application_by_id

SmartRecruiters: Finds job level interview templates by job application id. Finds job level interview templates that suppose to be used for interview / group interview scheduling. Finds by job application UUID. Required: id.

get_interview_templates_job_templates_job_by_id

SmartRecruiters: Finds job level interview templates for a job. Finds job level interview templates for a job, grouped and ordered by hiring stage and hiring step. Required: id.

smart_recruiters_interview_templates_job_templates_jobs_search

SmartRecruiters: Finds job level interview templates by job application IDs. Finds job level interview templates that suppose to be used for interview / group interview creation by jobId and application IDs. Required: job_id.

get_interview_templates_job_templates_jobs_hiring_stage_by_id

SmartRecruiters: Finds job level interview templates for job id, hiring step and hiring stage. Finds job level interview templates that suppose to be used for interview / group interview creation. Required: id, job_id, hiringStep.

update_interview_templates_job_templates_jobs_hiring_stage_by_id

SmartRecruiters: Save / replace job level interview templates for job id, hiring step and hiring stage. Required: id, job_id, hiringStep.

get_interview_templates_managed_steps_job_by_id

SmartRecruiters: Get managed hiring process steps for the job. Gets managed hiring process steps for the job's hiring process. Managed steps are used to control whether for given hiring stage and step is is required to have an interview template assigned. Required: id.

update_interview_templates_managed_steps_job_by_id

SmartRecruiters: Update managed steps for the job. Updates managed steps for the job's hiring process. Allows to decide whether for given hiring stage and step it is required to have an interview template assigned. Required: id.

get_interview_templates_schedule_preferences_user_by_id

SmartRecruiters: Find schedule preferences. Finds schedule preferences for provided user. Required: id.

list_all_smart_recruiters_interview_templates_templates

SmartRecruiters: Get interview templates for the current company. Finds interview templates for the current company.

create_a_smart_recruiters_interview_templates_template

SmartRecruiters: Create a interview template. Creates a new interview template.

delete_a_smart_recruiters_interview_templates_template_by_id

SmartRecruiters: Removes interview template. Delete interview template. Required: id.

get_single_smart_recruiters_interview_templates_template_by_id

SmartRecruiters: Get interview template by id. Returns a interview template by id. Required: id.

update_a_smart_recruiters_interview_templates_template_by_id

SmartRecruiters: Update interview template. Required: id.

smart_recruiters_jobs_headcount_bulk_update

SmartRecruiters: Update job headcount. Required: job_id.

create_a_smart_recruiters_jobs_hiring_team

SmartRecruiters: Add hiring team member of a job with a given id. Required: job_id.

delete_a_smart_recruiters_jobs_hiring_team_by_id

SmartRecruiters: Removes hiring team member of a job with a given id. Required: id, job_id.

create_a_smart_recruiters_jobs_jobad

SmartRecruiters: Create a new job ad. Required: job_id.

get_single_smart_recruiters_jobs_jobad_by_id

SmartRecruiters: Get a job ad. Required: id, job_id.

update_a_smart_recruiters_jobs_jobad_by_id

SmartRecruiters: Update a job ad. Enables you to update an existing job ad. NOTE: In order for a job ad changes to be reflected on internal sources (Career Sites, Job Widgets etc.) and Job Aggregators, you need to Publish the job ad after making an update. Required: id, job_id.

delete_a_smart_recruiters_jobs_jobads_posting_by_id

SmartRecruiters: Unpublish a job ad. Unpublishes a job ad from all sources. Unpublishing a default job ad will unpublish all other job ads within that job. Required: id, job_id.

create_a_smart_recruiters_jobs_jobads_posting

SmartRecruiters: Publishes a job ad. Publishes a job ad to internal sources (Career Pages, Job Widget, Facebook App, WordPress Plugin, Posting API) and optionally to all free job aggregators. By default it's set to publish to job aggregators and internal sources It reflects a Publish action… Required: job_id, job_ad_id.

get_single_smart_recruiters_jobs_note_by_id

SmartRecruiters: Get note of a job. Required: id.

smart_recruiters_jobs_note_bulk_update

SmartRecruiters: Update note of a job. Required: job_id.

create_a_smart_recruiters_jobs_position

SmartRecruiters: Create a new position for a job. Required: job_id.

delete_a_smart_recruiters_jobs_position_by_id

SmartRecruiters: Delete position. Required: id, job_id.

get_single_smart_recruiters_jobs_position_by_id

SmartRecruiters: Get a single position. Required: id, job_id.

update_a_smart_recruiters_jobs_position_by_id

SmartRecruiters: Update position. Required: id, job_id.

delete_a_smart_recruiters_jobs_publication_by_id

SmartRecruiters: Unpublishes a job from all sources. Required: id.

create_a_smart_recruiters_jobs_publication

SmartRecruiters: Publishes a default job ad. Publishes default job ad to internal sources and to free job aggregators. It reflects a Publish action available in the SmartRecruiters UI. Note: Internal sources: Career Pages, Job Widget, Facebook App, WordPress Plugin, Posting API depend on a company's… Required: job_id.

smart_recruiters_jobs_status_bulk_update

SmartRecruiters: Updates job status. Required: job_id.

create_a_smart_recruiters_messages_share

SmartRecruiters: Shares new messages on Hireloop with Users, Hiring Teams or Everyone and sends emails. How does it work: In content field, provide a text to be shared. @-mention users to send them an email In content field use @[USER:id] to mention a User, e.g. @[USER:324132421] Email responses are added as comments to your update \-tag candidates to link…

delete_a_smart_recruiters_messages_share_by_id

SmartRecruiters: Delete a message. Delete a message with a given id. Deleted message is no longer visible on Hireloop. Required: id.

list_all_notification_preferences_employee_preferences

SmartRecruiters: Get list of employee notifications preferences for a specific channel. Required: channel.

notification_preferences_employee_preferences_bulk_update

SmartRecruiters: Activate or deactivate employee notification preferences for hiring roles and notification channels in bulk.

create_notification_preferences_employee_preference

SmartRecruiters: Save employee notifications preferences. Required: channel.

list_all_notification_preferences_employee_preferences_all

SmartRecruiters: Get list of all employee notifications preferences.

list_all_notification_preferences_global_preferences

SmartRecruiters: Find global notification preferences.

notification_preferences_global_preferences_bulk_update

SmartRecruiters: Activate or deactivate global notification preferences for hiring roles and notification channels in bulk.

list_all_notification_preferences_notification_types

SmartRecruiters: Find all supported notification types along with applicable roles and channels they can be delivered.

list_all_smart_recruiters_offers_documents

SmartRecruiters: Get a list of documents related to sent offer. Required: offer_id.

get_single_smart_recruiters_offers_document_by_id

SmartRecruiters: Get a given document in a given sent offer. The id is the document id. Required: id, offer_id.

create_self_scheduling_automated_self_schedule

SmartRecruiters: Creates automated self schedule.

self_scheduling_automated_self_schedules_application_slots_count

SmartRecruiters: Returns the automated schedule available slots count based on interviewers availability and specified date params. Returns automated reschedule available slots count based on interviewers availability and specified date params. Required: schedule_type, application_uuid.

create_self_scheduling_automated_self_schedules_reschedule

SmartRecruiters: Requests self reschedule for candidate for automated self-schedule. Requests automated self-reschedule for application by cancelling existing interview and updating existing self-schedule. Interview must exist. Old link to self-schedule will be valid.

create_self_scheduling_automated_self_schedules_update_invite

SmartRecruiters: Requests invite update for automated self-schedule. Requests automated self-schedule update for candidate. Interview must NOT exist. If interview exists request self-reschedule must be used instead. Old link to self-schedule will be valid.

list_all_smart_recruiters_self_scheduling_self_schedules

SmartRecruiters: Search for a self-scheduling instances. Search for a self-schedules. Required: applicationId.

delete_a_smart_recruiters_self_scheduling_self_schedule_by_id

SmartRecruiters: Cancels self schedule. Required: id.

get_single_smart_recruiters_self_scheduling_self_schedule_by_id

SmartRecruiters: Gets self schedule by id. Required: id.

get_self_scheduling_self_schedules_application_by_id

SmartRecruiters: Retrieve application-related details for a self-scheduling instance. Required: id, self_schedule_id.

get_self_scheduling_self_schedules_application_interview_by_id

SmartRecruiters: Returns self-scheduled interview. Returns self-scheduled interview by self schedule id and application id Required: id, self_schedule_id.

create_self_scheduling_self_schedules_application_interview

SmartRecruiters: Create a self schedule interview. Create a self schedule interview by ID and application UUID Required: self_schedule_id, application_uuid.

self_scheduling_self_schedules_application_interview_bulk_update

SmartRecruiters: Update a self schedule interview. Update a self schedule interview by ID and application UUID Required: application_id, self_schedule_id.

list_all_self_scheduling_self_schedules_application_slots

SmartRecruiters: Get self-schedule slots for application. Returns available self-schedule slots for application Required: self_schedule_id, application_uuid.

create_a_smart_recruiters_url_shortener_shorten

SmartRecruiters: Shorten URL. Shorten provided long url and returns new url as json. Allows to shorten only URLs with smartrecruiters.com domain.

list_all_smart_recruiters_users_v_1

SmartRecruiters: List users of your company.

create_a_smart_recruiters_users_v_1

SmartRecruiters: Create a new user.

get_single_smart_recruiters_users_v_1_by_id

SmartRecruiters: Get details of a user with given id. Required: id.

smart_recruiters_users_v_1_partial_update

SmartRecruiters: Update a user. Required: user_id.

delete_a_smart_recruiters_users_v_1_by_id

SmartRecruiters: Deactivate a user (legacy endpoint; SmartRecruiters has no API to permanently delete users, so the user stays listed as inactive). Prefer DELETE /user-api/v201804/users/{id}/activation. Required: id.

delete_a_smart_recruiters_users_activation_v_1_by_id

SmartRecruiters: Deactivate a user. Required: id.

smart_recruiters_users_activation_v_1_bulk_update

SmartRecruiters: Activate a user. Activate a user with given id. Users created via an API are not active. This method allows activating a user so he/she can sign in straight away. Required: user_id.

create_a_smart_recruiters_users_activation_email_v_1

SmartRecruiters: Send an activation email to a user. Send an activation email to a user with given id. Users created via an API are not active. This method is an alternative to activating a user directly and allows sending an activation email in which a user will have to open a link and follow instructions on a… Required: user_id.

smart_recruiters_users_avatar_v_1_bulk_update

SmartRecruiters: Update user avatar. Required: user_id.

list_all_smart_recruiters_users_me

SmartRecruiters: Get details of my user.

list_all_smart_recruiters_companies_departments

SmartRecruiters: List departments for given company. Required: company_identifier.

list_all_smart_recruiters_configs

SmartRecruiters: Fetch list of vendor configs. Enables you to get all specified configuration entries.

create_a_smart_recruiters_config

SmartRecruiters: Add new config. Enables you to add a new config to the configs list. This operation requires passing an instance of the Config object with the Id and Value fields set. An update is performed if the ID that you pass already exists.

get_single_smart_recruiters_config_by_id

SmartRecruiters: Get config for vendor. Enables you to get the config value for a given Id. Required: id.

update_a_smart_recruiters_config_by_id

SmartRecruiters: Update config. Enables you to update config in the configs list. This operation requires passing a config id and instance of the Config object with the Id and Value fields set. Required: id.

get_single_smart_recruiters_candidate_application_status_by_id

SmartRecruiters: Get candidate status. Get candidates application status from the candidate perspective. Possible statuses are: NEW, IN_REVIEW, INTERVIEW, OFFERED, HIRED, ARCHIVED. For ARCHIVED there is also substatus returned: REJECTED, WITHDRAWN_BY_APPLICANT, TRANSFERRED, DELETED_BY_COMPANY. Required: id.

get_smartonboard_activity_assignment_attachment_by_id

SmartRecruiters: Returns single Attachment for specific Activity Assignment. Required: id, activity_assignment_id.

get_smartonboard_onboarding_process_assignment_by_id

SmartRecruiters: Returns specific Assignment associated with a single Onboarding Process. Required: id, onboarding_process_id.

notification_preferences_employee_preference_partial_update

SmartRecruiters: Update employee notifications preferences. Required: preference_id.

list_all_smart_recruiters_offers_search

SmartRecruiters: Search offers by criteria. Enables you to get a list of existing offers. The number of offers returned as part of the list can be modified using the offset and limit parameters. These results will be sorted using lastUpdateDate.

list_all_smart_recruiters_interview_templates

SmartRecruiters: Search for all interview templates. Searches for all interview templates. Supports paging and case-insensitive partial search by template name.

create_a_smart_recruiters_interview_template

SmartRecruiters: Create interview template. Creates interview template. Deprecated: use POST /public-api/templates instead.

delete_a_smart_recruiters_interview_template_by_id

SmartRecruiters: Remove interview template by id. Deletes interview template by id. Deprecated: use DELETE /public-api/templates/{id} Required: id.

get_single_smart_recruiters_interview_template_by_id

SmartRecruiters: Get interview template by id. Gets interview template by id. Deprecated: use GET /public-api/templates/{id} instead. Required: id.

update_a_smart_recruiters_interview_template_by_id

SmartRecruiters: Update interview template by id. Updates interview template by id. Deprecated: use PUT /public-api/templates/{id} instead. Required: id.

get_interview_templates_job_application_by_id

SmartRecruiters: Find interview templates for job application id. Finds interview template that suppose to be used for interview creation for job associated with provided job application id. The hiring stage and hiring step the job application is currently in are taken into account when searching for matching interview… Required: id.

smart_recruiters_interview_templates_job_partial_update

SmartRecruiters: Update interviewers selection for job interview template. Updates the selection of interviewers for job interview template. Required: job_interview_template_id.

update_a_smart_recruiters_interview_templates_job_by_id

SmartRecruiters: Update job interview template. Updates job interview template. Required: id.

get_single_smart_recruiters_interview_templates_job_by_id

SmartRecruiters: Find interview templates for the job. Finds job interview templates, grouped and ordered by hiring stage and hiring step. Required: id.