> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# SmartRecruiters

> How to set up the SmartRecruiters connector, plus the actions and events that are available.

![SmartRecruiters](https://stackone-logos.com/api/smartrecruiters/filled/svg)

v2.1.1[See changelog](https://docs.stackone.com/connectors/smartrecruiters/changelog.md)

[169 actions](#actions) · [15 events](#events) · 1 auth method

ATS
IAM

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [API Key · Connector Profile](https://docs.stackone.com/connectors/smartrecruiters/guides/connector-profile/api-key.md)
>
> Uses an API key created in SmartRecruiters. Access is limited to the system role and access group chosen for the key.

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [API Key · Link Account](https://docs.stackone.com/connectors/smartrecruiters/guides/link-account/api-key.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

Scopes

Select all
|
Clear

approvals\_create

approvals\_read

candidate\_applications\_manage

candidate\_status\_read

candidate\_view\_application\_status\_read

candidates\_create

candidates\_manage

candidates\_offers\_read

candidates\_parse\_resume

candidates\_read

company\_read

configuration\_manage

configuration\_read

interview\_templates\_manage

interview\_templates\_read

interview\_types\_read

interview\_types\_write

interviews\_read

interviews\_write

job\_applications\_manage

job\_applications\_read

jobs\_manage

jobs\_publications\_manage

jobs\_read

reviews\_delete

reviews\_read

reviews\_write

schedule\_preferences\_read

user\_me\_read

users\_manage

users\_read

No scopes found

169 actions

ActionDescriptionRequired scopes

Get Application Configuration For Posting`smartrecruiters_get_apply_configuration_for_posting`

Get application configuration including screening questions and privacy policies

`candidate_applications_manage`

Create Candidate Application`smartrecruiters_create_candidate_application`

Create a new candidate application for a job posting

`candidate_applications_manage`

Get Application Status`smartrecruiters_get_application_status`

Get the current status of a candidate's application for a job posting

`candidate_applications_manage`

Get Job Application`smartrecruiters_get_job_application`

Get a job application by its ID

`job_applications_read`

Delete Job Application`smartrecruiters_delete_job_application`

Delete a job application by its ID

`job_applications_manage`

List Pending Approvals`smartrecruiters_list_approvals`

Get all pending approval requests for the authenticated user

`approvals_read`

Get Approval Request`smartrecruiters_get_approval`

Get an approval request by its ID

`approvals_read`

Create Approval Request`smartrecruiters_create_approval`

Create a new approval request based on an existing approval

`approvals_create`

Approve Approval Request`smartrecruiters_approve_approval`

Approve an approval request by its ID

`approvals_create`

Reject Approval Request`smartrecruiters_reject_approval`

Reject an approval request by its ID

`approvals_create`

List Approval Comments`smartrecruiters_list_approval_comments`

Get all comments for an approval request

`approvals_read`

Add Approval Comment`smartrecruiters_create_approval_comment`

Add a comment to an approval request

`approvals_create`

Search Candidates`smartrecruiters_search_candidates`

Search for candidates in SmartRecruiters with optional filters

`candidates_read`

Get Candidate`smartrecruiters_get_candidate`

Get detailed information about a specific candidate

`candidates_read`

Create Candidate`smartrecruiters_create_candidate`

Create a new candidate and assign to a Talent Pool

`candidates_create`

Update Candidate`smartrecruiters_update_candidate`

Update personal information for an existing candidate

`candidates_manage`

Delete Candidate`smartrecruiters_delete_candidate`

Delete a candidate from SmartRecruiters

`candidates_manage`

Get Candidate Tags`smartrecruiters_get_candidate_tags`

Retrieve all tags assigned to a candidate

`candidates_read`

Add Candidate Tags`smartrecruiters_add_candidate_tags`

Add new tags to a candidate without replacing existing tags

`candidates_manage`

Update Candidate Tags`smartrecruiters_update_candidate_tags`

Replace all tags for a candidate with a new set of tags

`candidates_manage`

Delete Candidate Tags`smartrecruiters_delete_candidate_tags`

Remove all tags from a candidate

`candidates_manage`

Get Candidate Onboarding Status`smartrecruiters_get_candidate_onboarding_status`

Get onboarding status for a candidate (deprecated - use job-specific endpoint)

`candidate_status_read`

Get Candidate Onboarding Status For Job`smartrecruiters_get_candidate_onboarding_status_for_job`

Get onboarding status for a candidate in context of a specific job

`candidate_status_read`

Update Candidate Onboarding Status For Job`smartrecruiters_update_candidate_onboarding_status_for_job`

Set onboarding status for a candidate in context of a specific job

`candidates_manage`

List Candidate Attachments`smartrecruiters_list_candidate_attachments`

Retrieve all attachments for a candidate

`candidates_read`

Get Candidate Attachment`smartrecruiters_get_candidate_attachment`

Retrieve a specific attachment by its unique ID

`candidates_read`

List Candidate Attachments For Job`smartrecruiters_list_candidate_attachments_for_job`

Retrieve all attachments for a candidate's job application

`candidates_read`

Upload Candidate Attachment For Job`smartrecruiters_upload_candidate_attachment_for_job`

Upload a file attachment to a candidate in the context of a specific job application. The file must be provided as base6...

`candidates_manage`

Delete Candidate Attachment`smartrecruiters_delete_candidate_attachment_for_job`

Delete a specific attachment by its unique ID

`candidates_manage`

Get Candidate Status`smartrecruiters_get_candidate_status`

Get public-facing application status for a candidate

`candidate_view_application_status_read`

Update Candidate Status`smartrecruiters_update_candidate_status`

Update a candidate's status for a specific job application

`candidates_manage`

Get Candidate Status History For Job`smartrecruiters_get_candidate_status_history_for_job`

Get status history for a candidate's specific job application

`candidates_read`

Get Candidate Properties For Job`smartrecruiters_get_candidate_properties_for_job`

Get property values for a candidate's job application

`candidates_read`

Get Candidate Consent Status`smartrecruiters_get_candidate_consent_status`

Get consent status for a candidate

`candidates_read`

Get Candidate Consent Decisions`smartrecruiters_get_candidate_consent_decisions`

Get consent decisions for a candidate

`candidates_read`

Update Candidate Source`smartrecruiters_update_candidate_source`

Update the source information for a candidate

`candidates_manage`

Get Candidate Screening Answers`smartrecruiters_get_candidate_screening_answers`

Get screening question answers for a candidate

`candidates_read`

Create A New Candidate And Assign To A Job`smartrecruiters_add_candidate_to_job`

Create a new candidate and assign to a job

`candidates_create`

Get Candidate Application`smartrecruiters_get_candidate_application`

Get details of a candidate's job application

`candidates_read`

Delete Candidate Application`smartrecruiters_delete_candidate_application`

Delete a candidate's job application

`candidates_manage`

Parse Resume`smartrecruiters_parse_resume`

Parse a resume file and extract structured candidate data. The file must be provided as base64 encoded content — do not...

`candidates_parse_resume`

List Configuration Access Groups`smartrecruiters_list_configuration_access_groups`

List all access groups via the Configuration API with pagination

`configuration_read`

Get Access Group`smartrecruiters_get_access_group`

Get details of a specific access group

`configuration_read`

Create Access Group`smartrecruiters_create_access_group`

Create a new access group with given properties and criteria

`configuration_manage`

Update Access Group`smartrecruiters_update_access_group`

Update an existing access group

`configuration_manage`

Get Company Information`smartrecruiters_get_company`

Get all information about your company

`company_read`

List Job Properties`smartrecruiters_list_job_properties`

Get a list of the company's custom job properties

`configuration_read`

Create Job Property`smartrecruiters_create_job_property`

Create a new job property

`configuration_manage`

Get Job Property`smartrecruiters_get_job_property`

Get details of a specific job property

`configuration_read`

Get Job Property Values`smartrecruiters_get_job_property_values`

Get available values for a custom job property

`configuration_read`

Create Job Property Value`smartrecruiters_create_job_property_value`

Create a new value for a job property

`configuration_manage`

Archive Job Property Value`smartrecruiters_archive_job_property_value`

Archive a job property value

`configuration_manage`

Activate Job Property`smartrecruiters_activate_job_property`

Activate a job property

`configuration_manage`

Get Job Property Dependents`smartrecruiters_get_job_property_dependents`

Get dependent properties for a job property

`configuration_read`

Create Job Property Dependents`smartrecruiters_create_job_property_dependents`

Create dependencies between job properties

`configuration_manage`

Get Job Property Dependent Values`smartrecruiters_get_job_property_dependent_values`

Get values for a dependent job property

`configuration_read`

Get Job Property Value Dependents`smartrecruiters_get_job_property_value_dependents`

Get dependent values for a specific job property value

`configuration_read`

Add Job Property Dependent Value`smartrecruiters_add_job_property_dependent_value`

Add a dependent value for a specific job property value

`configuration_manage`

List Departments`smartrecruiters_list_departments`

Get all departments configured in the company

`configuration_read`

Get Department`smartrecruiters_get_department`

Get a department by its ID

`configuration_read`

Create Department`smartrecruiters_create_department`

Create a new department

`configuration_manage`

List Hiring Processes`smartrecruiters_list_hiring_processes`

Get all hiring processes configured in the company

`configuration_read`

Get Hiring Process`smartrecruiters_get_hiring_process`

Get a hiring process by its ID

`configuration_read`

List Offer Properties`smartrecruiters_list_offer_properties`

Get all available offer properties

`configuration_read`

List Candidate Properties`smartrecruiters_list_candidate_properties`

Get all available candidate properties

`configuration_read`

Get Candidate Property`smartrecruiters_get_candidate_property`

Get a candidate property by its ID

`configuration_read`

Get Candidate Property Values`smartrecruiters_get_candidate_property_values`

Get available values for a candidate property

`configuration_read`

Create Candidate Property Value`smartrecruiters_create_candidate_property_value`

Create a new value for a SINGLE\_SELECT candidate property

`configuration_manage`

Update Candidate Property Value Label`smartrecruiters_update_candidate_property_value`

Update the label of a candidate property value

`configuration_manage`

Get Candidate Property Value`smartrecruiters_get_candidate_property_value`

Get a specific candidate property value by ID

`configuration_read`

Get Source Types`smartrecruiters_get_source_types`

Get all available candidate source types with subtypes

`configuration_read`

Get Source Values`smartrecruiters_get_source_values`

Get all source values for a specific source type

`configuration_read`

Get Source Value`smartrecruiters_get_source_value`

Get a specific candidate source by ID

`configuration_read`

Get Source By Identifier`smartrecruiters_get_source_by_identifier`

Get a candidate source by its unique identifier

`configuration_read`

List Rejection Reasons`smartrecruiters_list_rejection_reasons`

Get all available rejection reasons

`configuration_read`

List Withdrawal Reasons`smartrecruiters_list_withdrawal_reasons`

Get all available withdrawal reasons

`configuration_read`

List Career Sites`smartrecruiters_list_career_sites`

Get all career sites configurations

`configuration_read`

Get Career Site`smartrecruiters_get_career_site`

Get details of a specific career site configuration

`configuration_read`

List Predefined Locations`smartrecruiters_list_predefined_locations`

Get all predefined locations configured in the company

`configuration_read`

Create Predefined Location`smartrecruiters_create_predefined_location`

Create a new predefined location

`configuration_manage`

Get Predefined Location`smartrecruiters_get_predefined_location`

Get a predefined location by its ID

`configuration_read`

Update Predefined Location`smartrecruiters_update_predefined_location`

Update an existing predefined location

`configuration_manage`

Delete Predefined Location`smartrecruiters_delete_predefined_location`

Delete a predefined location

`configuration_manage`

List Experience Levels`smartrecruiters_list_experience_levels`

Get all available experience levels. Use the returned id values when setting the experienceLevel field on create\_job or...

List Functions`smartrecruiters_list_functions`

Get all available job functions. Use the returned id values when setting the function field on create\_job or update\_job.

List Industries`smartrecruiters_list_industries`

Get all available industries for job categorization. Use the returned id values when setting the industry field on creat...

Get Managed Hiring Process Steps`smartrecruiters_get_managed_hiring_process_steps`

Get managed hiring process steps for a job

`interview_templates_read`

Get Interview Template`smartrecruiters_get_interview_template`

Get interview template by ID

`interview_templates_manage`

Update Interview Template`smartrecruiters_update_interview_template`

Update an interview template

`interview_templates_manage`

Delete Interview Template`smartrecruiters_delete_interview_template`

Delete an interview template

`interview_templates_manage`

List Interview Templates`smartrecruiters_list_interview_templates`

Get interview templates for the current company

`interview_templates_manage`

Create Interview Template`smartrecruiters_create_interview_template`

Create a new interview template

`interview_templates_manage`

Get Job Interview Templates`smartrecruiters_get_job_interview_templates`

Find job-level interview templates for a job

`interview_templates_manage`

List Job Interview Templates`smartrecruiters_list_job_interview_templates`

Find all job-level interview templates for a job

`interview_templates_manage`

Get Application Interview Templates`smartrecruiters_get_application_interview_templates`

Find job-level interview templates by job application ID

`interview_templates_read`

Search Job Interview Templates`smartrecruiters_search_job_interview_templates`

Find job-level interview templates by job and application IDs

`interview_templates_manage`

Update Job Interview Template`smartrecruiters_update_job_interview_template`

Update a job-level interview template

`interview_templates_manage`

Save Job Interview Template`smartrecruiters_save_job_interview_template`

Save or replace job-level interview template for a hiring stage and step

`interview_templates_manage`

Patch Job Interview Template Interviewers`smartrecruiters_patch_job_interview_template_interviewers`

Update interviewers pool for a job-level interview template

`interview_templates_manage`

Get User Schedule Preferences`smartrecruiters_get_user_schedule_preferences`

Find schedule preferences for a user

`schedule_preferences_read`

Get Interview Types`smartrecruiters_get_interview_types`

Get available interview types in SmartRecruiters

`interview_types_read`

List Interviews`smartrecruiters_list_interviews`

Get a list of interviews in SmartRecruiters

`interviews_read`

Get Interview`smartrecruiters_get_interview`

Get a specific interview by its ID

`interviews_read`

Create Interview`smartrecruiters_create_interview`

Create a new interview for a candidate application

`interviews_write`

Update Interview`smartrecruiters_update_interview`

Modify an existing interview

`interviews_write`

Delete Interview`smartrecruiters_delete_interview`

Delete an existing interview

`interviews_write`

Update Interviewer Status`smartrecruiters_update_interviewer_status`

Change an interviewer's status in a given timeslot

`interviews_write`

Update Timeslot Candidate Status`smartrecruiters_update_timeslot_candidate_status`

Change a candidate's status in a given timeslot

`interviews_write`

Create Timeslot`smartrecruiters_create_timeslot`

Add a new timeslot to an existing interview

`interviews_write`

Get Timeslot`smartrecruiters_get_timeslot`

Retrieve a specific timeslot from an interview

`interviews_read`

Update Timeslot`smartrecruiters_update_timeslot`

Modify an existing timeslot in an interview

`interviews_write`

Delete Timeslot`smartrecruiters_delete_timeslot`

Delete a timeslot from an interview

`interviews_write`

Update Timeslot No-Show`smartrecruiters_update_timeslot_noshow`

Change the no-show value for a timeslot

`interviews_write`

Delete Interview Type`smartrecruiters_delete_interview_type`

Remove an interview type with the given name

`interview_types_write`

Search Jobs`smartrecruiters_search_jobs`

Search for jobs in SmartRecruiters with optional filters

`jobs_read`

Get Job`smartrecruiters_get_job`

Get detailed information about a specific job

`jobs_read`

Create Job`smartrecruiters_create_job`

Create a new job in SmartRecruiters

`jobs_manage`

Update Job`smartrecruiters_update_job`

Fully update a job with all fields including location, compensation, and properties

`jobs_manage`

Update Job Status`smartrecruiters_update_job_status`

Update the status of a job

`jobs_manage`

Get Job Status History`smartrecruiters_get_job_status_history`

Get the status change history for a job

`jobs_read`

Get Job Approvals`smartrecruiters_get_job_approvals`

Get the latest approval request for a job

`jobs_read`

List Job Positions`smartrecruiters_list_job_positions`

List all positions for a job

`jobs_read`

Get Job Position`smartrecruiters_get_job_position`

Get details of a specific position

`jobs_read`

Create Job Position`smartrecruiters_create_job_position`

Create a new position for a job

`jobs_manage`

Update Job Position`smartrecruiters_update_job_position`

Update an existing position

`jobs_manage`

Delete Job Position`smartrecruiters_delete_job_position`

Delete a position from a job

`jobs_manage`

List Job Ads`smartrecruiters_list_job_ads`

List all job advertisements for a job

`jobs_read`

Get Job Ad`smartrecruiters_get_job_ad`

Get details of a specific job ad

`jobs_read`

Create Job Ad`smartrecruiters_create_job_ad`

Create a new job advertisement

`jobs_manage`

Update Job Ad`smartrecruiters_update_job_ad`

Update an existing job advertisement

`jobs_manage`

List Job Ad Postings`smartrecruiters_list_job_ad_postings`

List all publications for a job ad

`jobs_read`

Publish Job Ad`smartrecruiters_publish_job_ad`

Publish a job ad to internal sources and job aggregators

`jobs_manage`

Unpublish Job Ad`smartrecruiters_unpublish_job_ad`

Unpublish a job ad from all distribution channels

`jobs_manage`

List Job Publications`smartrecruiters_list_job_publications`

List all publications for a job's default ad

`jobs_read`

Publish Job`smartrecruiters_publish_job`

Publish the job's default ad to internal sources and job aggregators

`jobs_publications_manage`

Unpublish Job`smartrecruiters_unpublish_job`

Unpublish the job from all publication sources

`jobs_publications_manage`

Get Hiring Team`smartrecruiters_get_hiring_team`

Get the hiring team for a job

`jobs_read`

Add Hiring Team Member`smartrecruiters_add_hiring_team_member`

Add a member to the job's hiring team

`jobs_manage`

Remove Hiring Team Member`smartrecruiters_remove_hiring_team_member`

Remove a member from the job's hiring team

`jobs_manage`

Get Job Note`smartrecruiters_get_job_note`

Get the note associated with a job

`jobs_read`

Update Job Note`smartrecruiters_update_job_note`

Update the note associated with a job

`jobs_manage`

List Candidate Offers`smartrecruiters_list_candidate_offers`

Get all offers for a candidate's job application

`candidates_offers_read`

Get Candidate Offer`smartrecruiters_get_candidate_offer`

Get a specific offer for a candidate's job application

`candidates_offers_read`

Get Offer Approval`smartrecruiters_get_offer_approval`

Get latest approval request for candidate's offer

`candidates_offers_read`

Search Offers`smartrecruiters_search_offers`

Search offers with filters

`candidates_offers_read`

List Offer Documents`smartrecruiters_list_offer_documents`

Get list of documents related to sent offer

`candidates_offers_read`

Get Offer Document`smartrecruiters_get_offer_document`

Get a specific document from a sent offer

`candidates_offers_read`

List Postings`smartrecruiters_list_postings`

Lists active postings published by a given company

List Company Departments`smartrecruiters_list_company_departments`

List departments for a given company

Get Posting`smartrecruiters_get_posting`

Get posting by posting id or uuid for a given company

Get Candidate Reviews`smartrecruiters_get_candidate_reviews`

Retrieves all reviews for specified candidate and job

`reviews_read`

Get Review`smartrecruiters_get_review`

Retrieves a review by ID

`reviews_read`

Create Review`smartrecruiters_create_review`

Creates a review for a candidate

`reviews_write`

Update Review`smartrecruiters_update_review`

Updates a review by ID

`reviews_write`

Delete Review`smartrecruiters_delete_review`

Deletes a review by ID

`reviews_delete`

Get Job Review Criteria`smartrecruiters_get_job_review_criteria`

Retrieves all criteria for specified job

`reviews_read`

List Types Of Employment`smartrecruiters_list_types_of_employment`

Get all available employment types. Use the returned id values when setting the typeOfEmployment field on create\_job or...

List Users`smartrecruiters_list_users`

List users of your company

`users_read`

Create User`smartrecruiters_create_user`

Create a new user in your company

`users_manage`

Get Current User`smartrecruiters_get_current_user`

Get details of the authenticated user

`user_me_read`

Get User`smartrecruiters_get_user`

Get details of a user by ID

`users_read`

Reset User Password`smartrecruiters_reset_user_password`

Send a password reset email to a user

`users_manage`

Send User Activation Email`smartrecruiters_send_user_activation_email`

Send an activation email to a user

`users_manage`

Activate User`smartrecruiters_activate_user`

Activate a user account

`users_manage`

Deactivate User`smartrecruiters_deactivate_user`

Deactivate a user account

`users_manage`

List System Roles`smartrecruiters_list_system_roles`

List all available system roles

`users_read`

List Access Groups`smartrecruiters_list_access_groups`

List access groups configured in your company

`users_read`

Assign Users To Access Group`smartrecruiters_assign_users_to_access_group`

Assign multiple users to an access group

`users_manage`

Remove User From Access Group`smartrecruiters_remove_user_from_access_group`

Remove a user from an access group

`users_manage`

## Events

Tags

Select all
|
Clear

Ads

Applications

Candidates

Jobs

Webhooks

No tags found

15 events

EventDescriptionTags

Active Check`smartrecruiters_active_check`

Responds to SmartRecruiters webhook activation verification by echoing back the x-hook-secret header.

Webhooks

Application Created`smartrecruiters_webhook_application_created`

Processes SmartRecruiters application.created events.

ApplicationsWebhooks

Application Status Updated`smartrecruiters_webhook_application_status_updated`

Processes SmartRecruiters application.status.updated events.

ApplicationsWebhooks

Application Fields Updated`smartrecruiters_webhook_application_fields_updated`

Processes SmartRecruiters application.fields.updated events.

ApplicationsWebhooks

Application Onboarding Status Updated`smartrecruiters_webhook_application_onboarding_status_updated`

Processes SmartRecruiters application.onboarding-status.updated events.

ApplicationsWebhooks

Candidate Created`smartrecruiters_webhook_candidate_created`

Processes SmartRecruiters candidate.created events.

CandidatesWebhooks

Candidate Updated`smartrecruiters_webhook_candidate_updated`

Processes SmartRecruiters candidate.updated events.

CandidatesWebhooks

Candidate Deleted`smartrecruiters_webhook_candidate_deleted`

Processes SmartRecruiters candidate.deleted events.

CandidatesWebhooks

Job Created`smartrecruiters_webhook_job_created`

Processes SmartRecruiters job.created events.

JobsWebhooks

Job Updated`smartrecruiters_webhook_job_updated`

Processes SmartRecruiters job.updated events.

JobsWebhooks

Job Status Updated`smartrecruiters_webhook_job_status_updated`

Processes SmartRecruiters job.status.updated events.

JobsWebhooks

Job Hiring Team Updated`smartrecruiters_webhook_job_hiring_team_updated`

Processes SmartRecruiters job.hiring-team.updated events.

JobsWebhooks

Job Ad Created`smartrecruiters_webhook_job_ad_created`

Processes SmartRecruiters job.ad.created events.

JobsAdsWebhooks

Job Ad Updated`smartrecruiters_webhook_job_ad_updated`

Processes SmartRecruiters job.ad.updated events.

JobsAdsWebhooks

Job Ad Postings Updated`smartrecruiters_webhook_job_ad_postings_updated`

Processes SmartRecruiters job.ad.postings.updated events.

JobsAdsWebhooks


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.