> ## 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.

# Vincere

> How to set up the Vincere connector, plus the actions that are available.

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

Previewv1.6.0[See changelog](https://docs.stackone.com/connectors/vincere/changelog.md)

[235 actions](#actions) · 2 auth methods

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] [OAuth2 · Connector Profile](https://docs.stackone.com/connectors/vincere/guides/connector-profile/oauth2.md)
>
> Requires app registration.

> [card] [Oauth for Testing · Connector Profile](https://docs.stackone.com/connectors/vincere/guides/connector-profile/oauth-for-testing.md)
>
> Use this authentication method for testing with an existing refresh token.

**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] [OAuth2 · Link Account](https://docs.stackone.com/connectors/vincere/guides/link-account/oauth2.md)

> [card] [Oauth for Testing · Link Account](https://docs.stackone.com/connectors/vincere/guides/link-account/oauth-for-testing.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

Authentication type

Select all
|
Clear

OAuth2

Oauth for Testing

No auth methods found

235 actions

ActionDescription

Search User's Activities`vincere_post_user_activities`

Search user's activities

Search Candidate's Activities`vincere_post_candidate_activities`

Search candidate's activities

Search Contact's Activities`vincere_post_contact_activities`

Search contact's activities

Search Position's Activities`vincere_post_position_activities`

Search position's activities

Search Company's Activities`vincere_post_company_activities`

Search company's activities

Search All Activities Between Two Dates`vincere_post_activity_search`

Search all activities between two dates

Create Comment`vincere_post_activity_comment`

Create Comment

Get Comment Details`vincere_get_activity_comment_id`

Get comment details

Update Comment`vincere_patch_activity_comment_id`

Update Comment

Get Comment's Categories`vincere_get_activity_comment_id_categories`

Get comment's categories

Get Comment's Linked Candidates`vincere_get_activity_comment_id_candidates`

Get comment's linked candidates

Get Comment's Linked Companies`vincere_get_activity_comment_id_companies`

Get comment's linked companies

Get Comment's Linked Contacts`vincere_get_activity_comment_id_contacts`

Get comment's linked contacts

Get Comment's Linked Jobs`vincere_get_activity_comment_id_positions`

Get comment's linked jobs

Get Comment's Notification Recipients`vincere_get_activity_comment_id_notifyees`

Get comment's notification recipients

Create Task`vincere_post_activity_task`

Create Task

Get Task Details`vincere_get_activity_task_id`

Get task details

Update Task`vincere_put_activity_task_id`

Update Task

Delete Task`vincere_delete_activity_task_id`

Delete task

Create Meeting`vincere_post_activity_meeting`

Create Meeting

Get Meeting Details`vincere_get_activity_meeting_id`

Get meeting details

Update Meeting`vincere_put_activity_meeting_id`

Update Meeting

Delete Meeting`vincere_delete_activity_meeting_id`

Delete meeting

Get Meeting's Categories`vincere_get_activity_meeting_id_categories`

Get meeting's categories

Get Meeting's Linked Candidates`vincere_get_activity_meeting_id_candidates`

Get meeting's linked candidates

Get Meeting's Linked Companies`vincere_get_activity_meeting_id_companies`

Get meeting's linked companies

Get Meeting's Linked Contacts`vincere_get_activity_meeting_id_contacts`

Get meeting's linked contacts

Get Meeting's Linked Jobs`vincere_get_activity_meeting_id_positions`

Get meeting's linked jobs

Get Meeting's Attendees`vincere_get_activity_meeting_id_attendees`

Get meeting's attendees

Get Meeting's Notification Recipients`vincere_get_activity_meeting_id_notifyees`

Get meeting's notification recipients

Search Activities`vincere_post_activities`

Search activities

Get Activity Details`vincere_get_activities_id`

Get activity details

Search Activities With Details`vincere_search_activities_with_details`

Search one page of activities and return each record's full details, including attachments and recipients

Create Job Application`vincere_post_application`

Create Job Application

Get Application Details`vincere_get_application_id`

Get application details

Delete Applications`vincere_delete_application_id`

Delete applications

Search Applications By Filter`vincere_post_application_filter`

Search applications by filter

Move Application Forward To Stage Sent`vincere_post_application_id_stage_next_sent`

Move application forward to stage sent

Move Application Forward To Stage Interview`vincere_post_application_id_stage_next_interview`

Move application forward to stage interview

Reject Application`vincere_post_application_id_stage_reject`

Reject Application

Get Application Stage Logs`vincere_get_application_id_log_list`

Get application stage logs

Get Application Logs On Range`vincere_get_application_log_list_range`

Get application logs on range

Get Application Actions`vincere_post_application_actions`

Get application actions

Get List Of Rejection Reasons`vincere_get_application_rejection-reasons`

Get list of rejection reasons

Get Substatus Of Application`vincere_get_application_substatus`

Get substatus of application

Update Application Substatus`vincere_put_application_id_substatus`

Update application substatus

Create Candidate`vincere_post_candidate`

Create candidate

Get Candidate Details`vincere_get_candidate_id`

Get candidate details

Update Candidate`vincere_patch_candidate_id`

Update Candidate

Get Candidate's Education Details`vincere_get_candidate_id_educationdetails`

Get candidate's education details

Get Candidate's Owners`vincere_get_candidate_id_owners`

Get candidate's owners

Get Candidate's Work Experiences`vincere_get_candidate_id_workexperiences`

Get candidate's work experiences

Get Candidate's Desired Job Types`vincere_get_candidate_id_desiredjobtypes`

Get candidate's desired job types

Get Candidate's Language Skills`vincere_get_candidate_id_languageskills`

Get candidate's language skills

Get Candidate's Industries`vincere_get_candidate_id_industries`

Get candidate's industries

Get Candidate's Functional Expertises`vincere_get_candidate_id_functionalexpertises`

Get candidate's functional expertises

Update Candidate's Functional Expertises`vincere_put_candidate_id_functionalexpertises`

Update the functional expertises linked to a candidate

Get Candidate's Sub-functional Expertises`vincere_get_candidate_id_subfunctionalexpertises`

Get candidate's sub-functional expertises for a functional expertise

Update Candidate's Sub-functional Expertises`vincere_put_candidate_id_subfunctionalexpertises`

Update the sub-functional expertises linked to a candidate under one functional expertise

Update Candidate's Functional And Sub-functional Expertises`vincere_put_candidate_id_fe_sfe`

Update (replace) a candidate's functional and sub-functional expertises in one call

Get Candidate's Desired Functional Expertises`vincere_get_candidate_id_desiredfunctionalexpertises`

Get candidate's desired functional and sub-functional expertises

Update Candidate's Desired Functional Expertises`vincere_put_candidate_id_desiredfunctionalexpertises`

Update candidate's desired functional and sub-functional expertises

Get Candidate's Current Location`vincere_get_candidate_id_currentlocation`

Get candidate's current location

Create Or Update Candidate's Current Location`vincere_put_candidate_id_currentlocation`

Create or update candidate's current location

Get Candidate's Company Location`vincere_get_candidate_id_companylocation`

Company location

Create Or Update Candidate's Company Location`vincere_put_candidate_id_companylocation`

Create or update company location

Get Candidate's Personal Location`vincere_get_candidate_id_personallocation`

Get candidate's personal location

Create Or Update Candidate's Personal Location`vincere_put_candidate_id_personallocation`

Create or update candidate's personal location

Get Candidate's Custom Fields`vincere_get_candidate_id_customfields`

Get candidate's custom fields

Get Candidate's Core Fields`vincere_get_candidate_id_corefields`

Get candidate's core fields

Get Candidate's Branches`vincere_get_candidate_id_branches`

Get candidate's branches

Get Candidate Status`vincere_get_candidate_id_candidatestatus`

Get candidate status

Update Candidate Status`vincere_put_candidate_id_candidatestatus`

Update candidate status

Get Candidate Source Contact`vincere_get_candidate_id_sourcecontact`

Get candidate source contact

Update Candidate Source Contact`vincere_put_candidate_id_sourcecontact`

Update candidate source contact

Get Candidate Working State`vincere_get_candidate_id_workingstate`

Get candidate working state

Update Candidate Working State`vincere_put_candidate_id_workingstate`

Update candidate working state

Get Candidate's Brands`vincere_get_candidate_id_brands`

Get candidate's brands

Get Candidate Notes`vincere_get_candidate_id_notes`

Candidate notes

Create Candidate Note`vincere_post_candidate_id_note`

Candidate notes

Update Candidate Note`vincere_put_candidate_id_notes_noteid`

Candidate notes

Delete Candidate Note`vincere_delete_candidate_id_notes_noteid`

Candidate notes

Get Candidate's Placement Status`vincere_get_candidate_id_placementstatus`

Candidate's placement statuss

Get Candidate Email Activity Information`vincere_get_candidate_id_emailactivity`

Get candidate email activity information

Get The List Of Active Applications`vincere_get_candidate_id_applications_active`

Get the list of active applications

Get Candidate's Compliance Setting`vincere_get_candidate_id_compliance`

Get candidate's compliance setting

Get Candidate's Applications`vincere_get_candidate_id_applications`

Get candidate's applications

Get Summary Status Of Each Applications Of Candidate`vincere_get_candidate_id_applications_status`

Get summary status of each applications of candidate

Upload Candidate Document`vincere_post_candidate_id_file`

Upload a document (resume, offer letter, etc.) to a candidate

Get Candidate's Document Detail`vincere_get_candidate_id_file_doc_id`

Get candidate's document detail

Update Candidate Document`vincere_put_candidate_id_file_doc_id`

Update candidate document

Get All Candidate's Documents`vincere_get_candidate_id_files`

Get all candidate's documents

Create Company`vincere_post_company`

Create Company

Get Company Details`vincere_get_company_id`

Get company details

Update Company`vincere_put_company_id`

Update Company

Delete Company`vincere_delete_company_id`

Delete company

Get All Company's Locations`vincere_get_company_id_locations`

Get all company's locations

Create Company Location`vincere_create_company_location`

Create a location for a company

Get Company's Location`vincere_get_company_location_loc_id`

Get company's location

Update Company Location`vincere_update_company_location`

Fully update a company location

Delete Company Location`vincere_delete_company_location_loc_id`

Delete company location

Get Company's Industries`vincere_get_company_id_industries`

Get company's industries

Get Company's Custom Fields`vincere_get_company_id_customfields`

Get company's custom fields

Create Or Update Company's Custom Fields`vincere_put_company_id_customfields`

Create or update company's custom fields

Get Company's Branches`vincere_get_company_id_branches`

Get company's branches

Get Company's Brands`vincere_get_company_id_brands`

Get company's brands

Get Company First Location By Country\_code`vincere_get_company_id_firstlocation`

Get company first location by country\_code

Get Company Status`vincere_get_company_id_companystatus`

Get company status

Update Company Status`vincere_put_company_id_companystatus`

Update company status

Get Company's Logo`vincere_get_company_id_logo`

Get company's logo

Upload New Company Document`vincere_post_company_id_file`

Upload new company document

Get All Company's Documents`vincere_get_company_id_files`

Get all company's documents

Create Contact`vincere_create_contact`

Create contact

Get Contact Details`vincere_get_contact`

Get contact details

Update Contact`vincere_update_contact`

Update Contact

Delete Contact`vincere_delete_contact`

Delete contact

Get Contact's Linked Jobs`vincere_get_contact_jobs`

Get contact's linked jobs

Get Contact's Industries`vincere_get_contact_ind`

Get contact's industries

Get Contact's Personal Location`vincere_get_contact_per_loc`

Get contact's personal location

Create Or Update Contact's Personal Location`vincere_put_contact_per_loc`

Create or update contact's personal location

Get All Contact's Work Locations`vincere_get_contact_work_loc`

Get all contact's work locations

Create Contact's Work Location`vincere_post_contact_work_loc`

Create contact's work location

Get Contact's Custom Fields`vincere_get_contact_cus_field`

Get contact's custom fields

Create Or Update Contact's Custom Fields`vincere_put_contact_cus_field`

Create or update contact's custom fields

Get First Contact Work Location`vincere_get_first_loc`

Get first contact work location

Get Contact's Branches`vincere_get_contact_branches`

Get contact's branches

Get Contact's Brands`vincere_get_contact_brands`

Get contact's brands

Get Contact Status`vincere_get_contact_status`

Get contact status

Update Contact Status`vincere_put_contact_status`

Update contact status

Get Contact Email Activity Information`vincere_getContactEmailActivity`

Get contact email activity information

Get Contact's Photo`vincere_get_contact_id_photo`

Get contact's photo

Upload New Contact Document`vincere_post_contact_id_file`

Upload new contact document

Get All Contact's Documents`vincere_get_contact_id_files`

Get all contact's documents

Get Distribution Lists Of A Contact Based On User's Permission`vincere_get_distributionlists_contact_contact_id_user_user_id`

Get distribution lists of a contact based on user's permission

Get Distribution Lists A User Can Use`vincere_get_distributionlists_user_user_id`

Get distribution lists a user can use

List Of Contact Details By A Distribution List And User`vincere_get_distlist_user_contacts`

List of contact details by a distribution list and user

List Of Contacts By A Distribution List`vincere_get_contacts_by_distribution_list`

List of contacts by a distribution list

Update Email Subscription Status`vincere_updateEmailSubscription`

Update email subscription status

Create Job`vincere_create_job`

Create a job with a fixed JOB category

Create Job Lead`vincere_create_job_lead`

Create a Job Lead

Update Job`vincere_update_job`

Fully update an existing job; keeping an existing internal recruiter or site manager takes two calls

Get Job Details`vincere_get_position_id`

Get job details

Get Job Screening Questions`vincere_get_position_id_screeningquestions`

Get job screening questions

Get Job Rating Skills`vincere_get_position_id_ratingskills`

Get job rating skills

Update Job Rating Skill`vincere_put_position_id_ratingskill_r_id`

Update job rating skill

Get Job's Owners`vincere_get_position_id_owners`

Get job's owners

Set Job Owners`vincere_set_job_owners`

Replace the complete owner list for a job

Get Job's Custom Fields`vincere_get_position_id_customfields`

Get job's custom fields

Create Or Update Job's Custom Fields`vincere_put_position_id_customfields`

Create or update job's custom fields

View A Job Compensation`vincere_get_position_id_compensation`

View a job compensation

View Placements Of Job`vincere_get_position_id_placements`

View placements of Job

Get Job's Branches`vincere_get_position_id_branches`

Get job's branches

Get Job's Brands`vincere_get_position_id_brands`

Get job's brands

Get Job Status`vincere_get_position_id_positionstatus`

Get job status

Update Position Status`vincere_put_position_id_positionstatus`

Update position status

Get Job's Applications`vincere_get_position_id_applications`

Get job's applications

Count Job Applications By Stage`vincere_count_job_applications_by_stage`

Count a job's applications in the supplied stages

Get Job's Company Logo`vincere_get_position_id_logo`

Get job's company logo

Get Placement Details`vincere_get_placement_id`

Get placement details

Get Placement Profit Splits`vincere_get_placement_profitsplits`

Get placement profit splits

Get Placement Custom Fields`vincere_get_placement_customfields`

Get placement custom fields

Get Placement Your-company Detail`vincere_get_placement_yourcompanydetail`

Get placement your-company detail

Get Placement Branches`vincere_get_placement_branches`

Get placement branches

Get Placement Amendment Reasons`vincere_get_placement_amendment_reasons`

Get placement amendment reasons

Accept An Offer`vincere_post_placement_acceptoffer`

Accept an offer

Reject An Offer`vincere_post_placement_rejectoffer`

Reject an offer

Reference List For Candidate Custom Field Definitions`vincere_get_configurablefield_candidatefield`

Reference list for candidate custom field definitions

Reference List For Contact Custom Field Definitions`vincere_get_configurablefield_contactfield`

Reference list for contact custom field definitions

Reference List For Company Custom Field Definitions`vincere_get_configurablefield_companyfield`

Reference list for company custom field definitions

Reference List For Job Custom Field Definitions`vincere_get_configurablefield_positionfield`

Reference list for job custom field definitions

Reference List For Placement Custom Field Definitions`vincere_get_configurablefield_placementfield`

Reference list for placement custom field definitions

Reference List For Candidate Sources`vincere_get_candidatesources`

Reference list for Candidate Sources

Reference List For Contact Sources`vincere_get_contactsources`

Reference list for Contact Sources

Reference List For Languages`vincere_get_def_language`

Reference list for languages

Reference List For Language Skill Levels`vincere_get_def_languagelevels`

Reference list for language skill levels

Reference List For Marital Status`vincere_get_def_maritalstatuses`

Reference list for marital status

Reference List For Nationalities`vincere_get_def_nationalities`

Reference list for nationalities

Reference List For Relocation Potentials`vincere_get_def_relocations`

Reference list for relocation potentials

Reference List For Candidate Statuses`vincere_get_def_status_candidate`

Reference list for candidate statuses

Reference List For Contact Statuses`vincere_get_def_status_contact`

Reference list for contact statuses

Reference List For Company Statuses`vincere_get_def_status_company`

Reference list for company statuses

Reference List For Job Statuses`vincere_get_def_custom_status_job`

Reference list for job statuses

Reference List For Countries`vincere_get_def_countries`

Reference list for countries

Reference List For Currencies`vincere_get_def_currencies`

Reference list for currencies

Reference List For Employment Types`vincere_get_def_employmenttypes`

Reference list for employment types

Get Reference Salary Type List For Permanent Jobs`vincere_get_def_salarytypes`

Get reference salary type list for permanent jobs

Get Reference Pay Interval List For Contract-related Jobs`vincere_get_def_payintervals`

Get reference pay interval list for contract-related jobs

Reference List For Genders`vincere_get_def_genders`

Reference list for genders

Reference List For Stages Of An Application`vincere_get_def_stages`

Reference list for stages of an Application

Reference List For Job Types`vincere_get_def_jobtypes`

Reference list for job types

Reference List For Job Subtypes`vincere_get_def_jobsubtypes`

Reference list for job subtypes

Reference List For Meeting Status`vincere_get_def_meetingstatuses`

Reference list for meeting status

Reference List For All Candidate Document Types.`vincere_get_def_candidate_documenttypes`

Reference list for all candidate document types.

Reference List For Document Types Based On User's Permission.`vincere_get_def_user_documenttypes`

Reference list for document types based on user's permission.

Reference List For All Activity's Categories`vincere_get_def_activity_categories`

Reference list for all activity's categories

Reference List For KPI Actions`vincere_get_def_activity_kpis`

Reference list of KPI actions for one entity type

Reference List For Contact Stage`vincere_get_def_contactstages`

Reference list for Contact Stage

Reference List For Company Stage`vincere_get_def_companystages`

Reference list for Company Stage

Reference List For All Total Pay Calculation Types`vincere_get_def_paycalculations`

Reference list for all total pay calculation types

Reference List For All Time Management Types`vincere_get_def_timetypes`

Reference list for all Time Management types

Reference List For All Contract Length Type`vincere_get_def_contractlengthtypes`

Reference list for all Contract length type

Reference List For All Pay Method`vincere_get_def_paymethods`

Reference list for all Pay Method

Reference List For All Team In Vincere`vincere_get_def_teams`

Reference list for all Team in Vincere

Reference List For All Brand In Vincere`vincere_get_def_brands`

Reference list for all Brand in Vincere

Reference List For All Branch In Vincere`vincere_get_def_branches`

Reference list for all Branch in Vincere

Reference List For All Division In Vincere`vincere_get_def_divisions`

Reference list for all Division in Vincere

Reference List For All User Location In Vincere`vincere_get_def_locations`

Reference list for all user Location in Vincere

Reference List For Job Status`vincere_get_def_jobstatus`

Reference list for job status

Reference List For Activity Names`vincere_get_def_activity_names`

Reference list for Activity names

Reference List For Functional Expertises`vincere_get_functionalexpertises`

Reference list for all functional expertises

Reference List For Sub-functional Expertises Of A Functional Expertise`vincere_get_functionalexpertise_id_subfunctionalexpertises`

Reference list of sub-functional expertises for one functional expertise

Reference List For Sub-functional Expertises`vincere_get_subfunctionalexpertises`

Reference list for all sub-functional expertises

Get Filter Values For Current User`vincere_get_report_statistics_filters`

Get filter values for current user

Search Candidate Records`vincere_get_candidate_search_matrix_vars`

Search candidate records

Search Job Records`vincere_get_position_search_matrix_vars`

Search job records

Search Contact Records`vincere_get_contact_search_matrix_vars`

Search contact records

Search Company Records`vincere_get_company_search_matrix_vars`

Search company records

Search User Records`vincere_get_user_search_matrix_vars`

Search user records

Get Offer Approval Setting`vincere_get_setting_offerapproval`

Get offer approval setting

Get Twilio Credentials`vincere_get_setting_twilio`

Get Twilio credentials

Get Talent Pools Of A Candidate Based On User's Permission`vincere_get_talentpools_candidate_candidate_id_user_user_id`

Get talent pools of a candidate based on user's permission

Get Talent Pools A User Can Use`vincere_get_talentpools_user_user_id`

Get talent pools a user can use

List Of Candidate Details By A Talent Pool And User`vincere_get_talentpool_id_user_user_id_candidates`

List of candidate details by a talent pool and user

List Of Candidates By A Talent Pool`vincere_get_candidates_by_talentpool`

List of candidates by a talent pool

Add Candidate To Talent Pools`vincere_add_candidate_to_talentpool`

Add candidate to talent pools

Remove Candidate From Talent Pools`vincere_remove_candidate_from_talentpool`

Remove candidate from talent pools

Get All Umbrella Companies`vincere_get_umbrellacompany_umbrellacompanies`

Get all umbrella companies

Get User By Email`vincere_get_user`

Get user by email

Search Users By Name`vincere_get_user_summaries`

Search users by name

Get All Users`vincere_get_user_summaries_all`

Get all users

Get All Active Users`vincere_get_user_summaries_active`

Get all active users

Get All Administrator Users`vincere_get_user_summaries_administrator`

Get all administrator users

Check If A User Exists`vincere_get_user_exists`

Check if a user exists

Get Current User`vincere_get_user_me`

Get current user

Get All Approvers`vincere_get_user_approvers`

Get all approvers


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