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

# SAP SuccessFactors

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

![SAP SuccessFactors](https://stackone-logos.com/api/sap-sucessfactors/filled/svg)

v3.0.4[See changelog](https://docs.stackone.com/connectors/sapsuccessfactors/changelog.md)

[120 actions](#actions) · 1 auth method

HRIS
ATS
LMS

## 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] [OAuth 2.0 · Connector Profile](https://docs.stackone.com/connectors/sapsuccessfactors/guides/connector-profile/oauth-2-0.md)
>
> Uses an OAuth2 client application registered in SAP SuccessFactors, with an X.509 certificate. Actions run with the perm...

**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] [OAuth 2.0 · Link Account](https://docs.stackone.com/connectors/sapsuccessfactors/guides/link-account/oauth-2-0.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

120 actions

ActionDescription

List Employee Addresses`sapsuccessfactors_list_employee_addresses`

List employee address records (PerAddressDEFLT), filterable by personIdExternal and addressType

Get Employee Address`sapsuccessfactors_get_employee_address`

Retrieve one employee address by personIdExternal, addressType and startDate

Upsert Address`sapsuccessfactors_upsert_address`

Create or update an employee address record (PerAddressDEFLT)

Create Attachment`sapsuccessfactors_create_attachment`

Upload a file as an Attachment in SAP SuccessFactors and return its attachmentId

List Available Time Types`sapsuccessfactors_list_available_time_types`

List available time types (the bookable timeType codes) per time type profile

Get Available Time Type`sapsuccessfactors_get_available_time_type`

Retrieve one available time type by profile code, profile start date and external code

List Benefit Enrollments`sapsuccessfactors_list_benefit_enrollments`

Retrieve benefit enrollment records for employees

List Benefits`sapsuccessfactors_list_benefits`

List the benefits configured in SAP SuccessFactors (benefit catalog)

List Benefit Programs`sapsuccessfactors_list_benefit_programs`

Retrieve benefit programs grouping related benefits

List Calibration Sessions`sapsuccessfactors_list_calibration_sessions`

Retrieve calibration sessions used to normalize performance ratings

List Candidates`sapsuccessfactors_list_candidates`

Retrieve a list of candidates

Get Candidate`sapsuccessfactors_get_candidate`

Retrieve a specific candidate by ID

Create Candidate`sapsuccessfactors_create_candidate`

Create a new candidate profile

Upsert Candidate`sapsuccessfactors_upsert_candidate`

Update an existing candidate profile using SAP's upsert operation

List Candidate Education`sapsuccessfactors_list_candidate_education`

Retrieve education records from candidate background profiles

List Candidate Work Experience`sapsuccessfactors_list_candidate_work_experience`

Retrieve internal (inside-company) work experience records from candidate background profiles

List Interviews`sapsuccessfactors_list_interviews`

Retrieve interview records linked to job applications

List Compensation Records`sapsuccessfactors_list_compensation_records`

List employee compensation records (EmpCompensation header: pay group, event reason, effective dates)

Get Compensation Record`sapsuccessfactors_get_compensation_record`

Retrieve a specific compensation record by seqNumber, startDate and userId

List Countries`sapsuccessfactors_list_countries`

Retrieve a list of countries

Get Country`sapsuccessfactors_get_country`

Retrieve a specific country by code

List Person Emails`sapsuccessfactors_list_person_emails`

Retrieve a list of person email records

Get Person Email`sapsuccessfactors_get_person_email`

Retrieve a specific person email record by composite key

Upsert Person Email`sapsuccessfactors_upsert_person_email`

Create or update a person email record

List Employments`sapsuccessfactors_list_employments`

Retrieve a list of employment records

Get Employment`sapsuccessfactors_get_employment`

Retrieve a specific employment record by composite key

Upsert Employment`sapsuccessfactors_upsert_employment`

Create or update an employee employment record (step 2 of 4 for adding a new employee)

List Job Records`sapsuccessfactors_list_job_records`

Retrieve a list of employee job records

Get Job Record`sapsuccessfactors_get_job_record`

Retrieve a specific job record by composite key (seqNumber, startDate, userId)

Upsert Job`sapsuccessfactors_upsert_job`

Create or update employee job information record (step 3 of 4 for adding new employee)

List Employee Education`sapsuccessfactors_list_employee_education`

Retrieve education records from employee background profiles

List Employee Work Experience`sapsuccessfactors_list_employee_work_experience`

Retrieve internal work experience records from employee background profiles

List Employee Languages`sapsuccessfactors_list_employee_languages`

Retrieve language proficiency records from employee background profiles

List Employee Awards`sapsuccessfactors_list_employee_awards`

Retrieve award/recognition records from employee background profiles

List Employee Time`sapsuccessfactors_list_employee_time`

Retrieve a list of employee time records

Get Employee Time`sapsuccessfactors_get_employee_time`

Retrieve a specific employee time record by external code

Create Employee Time (Leave Request)`sapsuccessfactors_create_employee_time`

Submit a new employee time record (leave request, sick day, vacation, etc.)

Delete Employee Time`sapsuccessfactors_delete_employee_time`

Delete an employee time record by external code

List Employment Terminations`sapsuccessfactors_list_employment_terminations`

Retrieve a list of employment termination records

Get Employment Termination`sapsuccessfactors_get_employment_termination`

Retrieve a specific employment termination record by composite key

List Job Applications`sapsuccessfactors_list_job_applications`

Retrieve a list of job applications

Get Job Application`sapsuccessfactors_get_job_application`

Retrieve a specific job application by ID

Create Job Application`sapsuccessfactors_create_job_application`

Create a new job application linking a candidate to a job requisition

Upsert Job Application`sapsuccessfactors_upsert_job_application`

Update an existing job application's pipeline status or source

List Job Locations`sapsuccessfactors_list_job_locations`

Retrieve a list of job location records

Get Job Location`sapsuccessfactors_get_job_location`

Retrieve a specific job location record by composite key

Create Job Location`sapsuccessfactors_create_job_location`

Create or update a job location (MDF) using SAP's upsert operation

Delete Job Location`sapsuccessfactors_delete_job_location`

Delete a job location record by composite key

List Job Offers`sapsuccessfactors_list_job_offers`

Retrieve a list of job offer records

Get Job Offer`sapsuccessfactors_get_job_offer`

Retrieve a specific job offer record by offer approval ID

List Job Requisitions`sapsuccessfactors_list_job_requisitions`

Retrieve a list of job requisitions with OData filter, select, and expand support

Create Job Requisition`sapsuccessfactors_create_job_requisition`

Create a new job requisition (opens a position for hiring)

Get Job Requisition`sapsuccessfactors_get_job_requisition`

Retrieve a specific job requisition by ID

List Job Requisition Templates`sapsuccessfactors_list_job_requisition_templates`

List the Job Requisition form templates configured in Recruiting (names and form template ids)

Assign Learning Item`sapsuccessfactors_assign_learning_item`

Assign a learning item (course) to a user in SAP SuccessFactors Learning

Unassign Learning Item`sapsuccessfactors_unassign_learning_item`

Remove a learning item assignment from a user in SAP SuccessFactors Learning

Create User Course Assignment`sapsuccessfactors_create_user_course_assignment`

Assign a course to a user with an assignment type, due date or assignment date

Create Learning User`sapsuccessfactors_create_learning_user`

Create a new external user in SAP SuccessFactors Learning

Upsert Learning User`sapsuccessfactors_upsert_learning_user`

Create or update a user's profile in SAP SuccessFactors Learning (full replacement)

List Learning Users`sapsuccessfactors_list_learning_users`

Retrieve a list of users/students in SAP SuccessFactors Learning

List Learning Courses`sapsuccessfactors_list_learning_courses`

Retrieve a list of courses/learning items in SAP SuccessFactors Learning

List Learning Items (for OCN Source Analysis)`sapsuccessfactors_list_ocn_sources`

List catalog items to see which OCN providers (sourceID) have content in Learning

Create/Update OCN Course`sapsuccessfactors_create_ocn_course`

Create or update a course in SAP SuccessFactors Learning via Open Content Network (OCN)

Create OCN Completion`sapsuccessfactors_create_ocn_completion`

Create a completion event for an OCN course in SAP SuccessFactors Learning

Record Learning Event (Learning History)`sapsuccessfactors_record_learning_event`

Record completions into Learning history for items that already exist in the LMS catalog

List Learning History`sapsuccessfactors_list_learning_history`

Retrieve the connected user's completed learning history (learning events) from SAP SuccessFactors Learning

Record External Learning Event`sapsuccessfactors_record_external_learning_event`

Record a free-text external learning completion (no catalog item) into a user's Learning history

List Goals`sapsuccessfactors_list_goals`

Retrieve a list of employee goals from a specific SAP SuccessFactors goal plan template

List Goal Plan Templates`sapsuccessfactors_list_goal_plan_templates`

Retrieve available goal plan templates from SAP SuccessFactors

List One-Time Payments`sapsuccessfactors_list_one_time_payments`

Retrieve one-time (non-recurring) pay component entries for employees

List Recurring Pay Components`sapsuccessfactors_list_recurring_pay_components`

Retrieve recurring pay component entries for employees (base salary, allowances)

List Payment Information Details`sapsuccessfactors_list_payment_information_details`

Retrieve direct deposit / bank account information for employees

List Skills`sapsuccessfactors_list_skills`

Retrieve a list of skills from SAP SuccessFactors (OData v2 SkillEntity)

List Competencies`sapsuccessfactors_list_competencies`

Retrieve a list of competencies from SAP SuccessFactors (OData v2 CompetencyEntity)

List Employee Person Info`sapsuccessfactors_list_employee_person_info`

Retrieve employee person records with core identifiers and birth information

Get Employee Personal Info`sapsuccessfactors_get_employee_personal_info`

Retrieve one person's core identity and birth record (PerPerson) by personIdExternal

Generate Next Person ID`sapsuccessfactors_generate_next_person_id`

Generate the next available person ID for creating a new employee in SAP SuccessFactors

Upsert Person`sapsuccessfactors_upsert_person`

Create or update employee record in PerPerson entity (step 1 of 4 for adding new employee)

List Employee Personal Details`sapsuccessfactors_list_employee_personal_details`

List employee personal detail records (PerPersonal: names, demographics) with filtering and pagination

Get Employee Personal Details`sapsuccessfactors_get_employee_personal_details`

Retrieve one PerPersonal record (names, demographics) by personIdExternal and startDate

Upsert Personal`sapsuccessfactors_upsert_personal`

Create or update employee personal information record (step 4 of 4 for adding new employee)

List Person Types`sapsuccessfactors_list_person_types`

Retrieve a list of person type definitions

Get Person Type`sapsuccessfactors_get_person_type`

Retrieve a specific person type by external code

Get Entity Metadata`sapsuccessfactors_get_entity_metadata`

Retrieve metadata definition for a specific OData entity in JSON format

List Picklists`sapsuccessfactors_list_picklists`

Retrieve all available MDF picklist definitions that can be used to get picklist values for form fields

Get Picklist`sapsuccessfactors_get_picklist`

Retrieve a specific MDF picklist definition by ID and effective start date

List Picklist Values`sapsuccessfactors_list_picklist_values`

Retrieve MDF picklist values (e.g. country, change reason, language options)

Get Picklist Value`sapsuccessfactors_get_picklist_value`

Retrieve a single MDF picklist value by picklistId, effectiveStartDate and externalCode

List Legacy Picklists`sapsuccessfactors_list_legacy_picklist`

Retrieve all legacy picklist definitions (pre-MDF picklist system)

Get Legacy Picklist`sapsuccessfactors_get_legacy_picklist`

Retrieve a specific legacy picklist definition by ID with option to expand picklist options

List Legacy Picklist Options`sapsuccessfactors_list_legacy_picklist_options`

Retrieve all options for a specific legacy picklist

List Event Reasons`sapsuccessfactors_list_event_reasons`

Retrieve event reason codes available for employment events like terminations, transfers, or status changes

List Person Phones`sapsuccessfactors_list_person_phones`

Retrieve a list of person phone records

Get Person Phone`sapsuccessfactors_get_person_phone`

Retrieve a specific person phone record by composite key

Upsert Person Phone`sapsuccessfactors_upsert_person_phone`

Create or update a person phone record

List Photos`sapsuccessfactors_list_photos`

Retrieve a list of user profile photos

Get Photo`sapsuccessfactors_get_photo`

Retrieve a specific user profile photo by userId and photoType

List Positions`sapsuccessfactors_list_positions`

Retrieve a list of positions from SAP SuccessFactors Position Management

Get Position`sapsuccessfactors_get_position`

Retrieve a specific position by its code and effective start date

List Job Codes`sapsuccessfactors_list_job_codes`

Retrieve a list of job codes from SAP SuccessFactors

List Departments`sapsuccessfactors_list_departments`

Retrieve a list of departments from SAP SuccessFactors

List Business Units`sapsuccessfactors_list_business_units`

Retrieve a list of business units from SAP SuccessFactors

List Cost Centers`sapsuccessfactors_list_cost_centers`

Retrieve a list of cost centers from SAP SuccessFactors

List Companies`sapsuccessfactors_list_companies`

Retrieve a list of companies/legal entities from SAP SuccessFactors

List Pay Grades`sapsuccessfactors_list_pay_grades`

Retrieve a list of pay grades from SAP SuccessFactors

List Pay Scale Levels`sapsuccessfactors_list_pay_scale_levels`

Retrieve valid Pay Scale Level codes from SAP SuccessFactors (use these as upsert\_job payScaleLevel values)

List Person Relationships`sapsuccessfactors_list_person_relationships`

Retrieve a list of person relationship records

Get Person Relationship`sapsuccessfactors_get_person_relationship`

Retrieve a specific person relationship by composite key

Upsert Person Relationship`sapsuccessfactors_upsert_person_relationship`

Create or update a person relationship record

List Talent Pools`sapsuccessfactors_list_talent_pools`

Retrieve talent pools configured in SAP SuccessFactors Succession Planning

List Time Accounts`sapsuccessfactors_list_time_accounts`

Retrieve employee time accounts and their validity windows

List Time Account Balances`sapsuccessfactors_list_time_account_balances`

Retrieve the current computed leave balance for an employee's time accounts

List Time Account Types`sapsuccessfactors_list_time_account_types`

Retrieve all time account types (leave types) configured in the system

List Holiday Calendars`sapsuccessfactors_list_holiday_calendars`

Retrieve holiday calendars configured in SAP SuccessFactors

List Users`sapsuccessfactors_list_users`

Retrieve a list of users with optional filtering, sorting, field selection, and pagination

Get User`sapsuccessfactors_get_user`

Retrieve detailed information for a specific user by userId

Create User`sapsuccessfactors_create_user`

Create a new user in the system

Update User`sapsuccessfactors_update_user`

Update an existing user's information

List Workflow Requests`sapsuccessfactors_list_workflow_requests`

Retrieve pending and completed workflow approval requests

List Workflow Steps`sapsuccessfactors_list_workflow_steps`

Retrieve approval steps for workflow requests


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