Skip to main content
SAP SuccessFactors logo
  • Category: human resources
  • Auth: SAML
  • Composio-managed OAuth available? N/A
  • Tools: 64
  • Triggers: 0
  • Slug: SAP_SUCCESSFACTORS
  • Version: 20261101_00

Tools

Slug: SAP_SUCCESSFACTORS_APPROVE_CALIBRATION_SESSIONFinalize a calibration session that is in the In Progress or Approving status.

Input Parameters

string
Optional comments for the approval
string
required
The calibration session ID to approve/finalize

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SAP_SUCCESSFACTORS_CREATE_A_FEEDBACK_REQUESTCreate a feedback request in SAP SuccessFactors Continuous Feedback. Use when you need to request performance feedback from one employee about another. At least one question must be provided.

Input Parameters

string
required
Topic or title of the feedback request. Describes what the feedback is about.
string
First feedback question. At least one question must be provided. Questions must be in order (cannot skip question1 if providing question2 or question3).
string
Second feedback question. Can only be provided if question1 is also provided. Questions must be in order.
string
Third feedback question. Can only be provided if both question1 and question2 are provided. Questions must be in order.
string
Optional additional text or context for the feedback request. Note: This field is not supported by the SAP SuccessFactors API and will be ignored.
string
required
Assignment UUID of the recipient (the person who will provide the feedback). This is who will be asked to provide feedback.
string
required
Assignment UUID of the requester (must be the authenticated user). This is the person requesting the feedback.
string
required
Assignment UUID of the subject user (the person the feedback is about). This is who the feedback will be about.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SAP_SUCCESSFACTORS_CREATE_LEARNING_ACTIVITIES_BULKCreate learning activities and associate them with development goals in bulk (requires third-party LMS integration).

Input Parameters

array
required
List of learning activities to create (requires third-party LMS integration)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SAP_SUCCESSFACTORS_CREATE_ONBOARDEECreates a new onboardee in SAP SuccessFactors Onboarding 2.0 system. Use when initiating the onboarding process for a new hire or rehire. Requires admin create user permissions.

Input Parameters

string
required
The email address of the onboardee. Must be a valid email format.
string
required
The user ID for the onboardee. This is a unique identifier for the user in the system.
string
required
Password for the onboardee account. Must meet the system’s password requirements.
string
required
The username for the onboardee. This will be used as the login identifier.
string
Indicates if this is a new hire. Expected values: ‘Yes’ or ‘No’. If not provided, system defaults will apply.
string
required
The application ID for the onboarding process. This identifies which onboarding workflow to use.
boolean
Identifies if the person is a rehire. Set to true to find and link to old employment record in the system.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SAP_SUCCESSFACTORS_CREATE_UPDATE_SUCCESSOR_NOMINATIONCreate or update a successor nomination for a position or talent pool in succession planning. Use when you need to nominate or update a successor for a specific position or talent pool.

Input Parameters

string
Optional notes or comments about the nomination.
integer
The ranking of the successor nominee. Used when multiple successors are nominated for the same position or pool.
string
required
The user ID of the nominee to be added or updated in the nomination.
number
The readiness level of the successor nominee. Typically a numeric value indicating how ready the person is for the role.
boolean
Indicates if the nominee is designated as emergency cover for the position.
string
required
Position code or talent pool identifier for the nomination target.
boolean
required
Indicates if this is a talent pool nomination. Set to false for position-based nominations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SAP_SUCCESSFACTORS_DELETE_NOMINATION_POSITION_TALENT_POOLDelete a nomination for a position or talent pool in succession planning. Use when you need to remove a nominee from a position or talent pool nomination.

Input Parameters

string
required
The user ID of the nominee to be removed from the nomination.
string
required
Position code or talent pool identifier for the nomination target.
boolean
required
Indicates if this is a talent pool nomination. Set to false for position-based nominations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SAP_SUCCESSFACTORS_GET_APPLICATION_INTERVIEWRetrieves interview information related to job applications from Interview Central. Use when you need to query interview schedules, statuses, or details for applicants. Note: This entity checks only the first 1000 records, so filtering by applicationId is recommended.

Input Parameters

integer
Maximum number of records to return (OData $top parameter)
integer
Number of records to skip for pagination (OData $skip parameter)
string
Navigation properties to expand (OData $expand parameter)
string
OData $filter expression to filter interviews. Important: This entity checks only the first 1000 records, so filtering by specific applicationId or job requisition ID is recommended for complete data retrieval.
string
Comma-separated list of fields to retrieve (OData $select parameter)
string
OData $orderby expression for sorting results

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SAP_SUCCESSFACTORS_GET_BACKGROUND_EDUCATIONTool to retrieve background education records for employees from SAP SuccessFactors. Use when you need to query education history with support for filtering, field selection, and pagination via OData query options. Background entities use backgroundElementId as the unique key field.

Input Parameters

integer
Maximum number of records to return (OData $top). Default is 100.
integer
Number of records to skip for pagination (OData $skip). Use with $top for pagination.
string
Navigation properties to expand (OData $expand)
string
OData $filter expression to filter education records (e.g., “userId eq ‘jdoe’” or “school eq ‘MIT’”)
string
Comma-separated list of fields to retrieve (OData $select). If not specified, all fields are returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SAP_SUCCESSFACTORS_GET_BACKGROUND_MOBILITYRetrieves mobility background records showing employee willingness to relocate. Use when you need to query employee geographic mobility preferences and location data. Results can be filtered and ordered by bgOrderPos to maintain screen display order.

Input Parameters

integer
Maximum number of records to return (OData $top parameter). Default is 100.
integer
Number of records to skip for pagination (OData $skip parameter). Use with $top for pagination.
string
Navigation properties to expand (OData $expand parameter)
string
OData $filter expression to filter mobility records (e.g., “userId eq ‘12345’” or “bgOrderPos eq 1”)
string
Comma-separated list of fields to retrieve (OData $select parameter). If not specified, all fields are returned.
string
OData $orderby expression for sorting results. Example: bgOrderPos asc or startDate desc

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SAP_SUCCESSFACTORS_GET_CALIBRATION_SESSION_BY_IDGet a specific calibration session by session ID.

Input Parameters

string
Navigation properties to expand (OData $expand)
string
Comma-separated list of fields to retrieve (OData $select)
string
required
The calibration session ID to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SAP_SUCCESSFACTORS_GET_CALIBRATION_SESSIONSQuery accessible calibration sessions with filtering, sorting and pagination.

Input Parameters

integer
Maximum number of records to return (OData $top)
integer
Number of records to skip for pagination (OData $skip)
string
OData $filter expression to filter sessions
string
Comma-separated list of fields to retrieve (OData $select)
string
OData $orderby expression for sorting results

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SAP_SUCCESSFACTORS_GET_CALIBRATION_SUBJECT_BY_IDGet a specific subject’s details within a calibration session by session and subject ID.

Input Parameters

string
Navigation properties to expand (OData $expand)
string
Comma-separated list of fields to retrieve (OData $select)
string
required
The calibration session ID
string
required
The subject ID to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SAP_SUCCESSFACTORS_GET_CALIBRATION_SUBJECT_RATINGSQuery subjects in a calibration session by session ID, with filtering and pagination.

Input Parameters

integer
Maximum number of records to return (OData $top)
integer
Number of records to skip for pagination (OData $skip)
string
OData $filter expression to filter subjects
string
Comma-separated list of fields to retrieve (OData $select)
string
required
The calibration session ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SAP_SUCCESSFACTORS_GET_CDP_LEARNING_METADATAGet metadata for Career Development Planning Learning service.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SAP_SUCCESSFACTORS_GET_CURRENT_USERRetrieves the currently authenticated user’s information from SAP SuccessFactors.

Input Parameters

string
Comma-separated list of fields to retrieve via OData $select parameter

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SAP_SUCCESSFACTORS_GET_CUSTOM_MDF_OBJECTQuery custom MDF object records from SAP SuccessFactors using the object name without the cust_ prefix. Results contain standard record metadata fields; custom object fields are not returned.

Input Parameters

integer
Maximum number of records to return (OData $top). Default is 100.
integer
Number of records to skip for pagination (OData $skip). Use with $top for pagination.
string
Navigation properties to expand (OData $expand), such as createdByNav, lastModifiedByNav, externalCodeNav
string
OData $filter expression to filter custom MDF object records
string
Comma-separated list of fields to retrieve via OData $select parameter
string
required
The name of the custom MDF object (without cust_ prefix). Example: COVID_19_VACCINE_TRACKING, EmpLetterRequest, HEALTH_STATUS_TRACKING

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SAP_SUCCESSFACTORS_GET_EMP_EMPLOYMENT_TERMINATIONRetrieves employee termination information records from SAP SuccessFactors, including termination dates. Supports filtering, field selection, expansion of related entities, and pagination via OData query options.

Input Parameters

integer
Maximum number of records to return (OData $top). Default is 100.
integer
Number of records to skip for pagination (OData $skip). Use with $top for pagination.
string
Navigation properties to expand via OData $expand parameter (e.g., “jobInfoNav” to include job information)
string
OData $filter expression to filter termination records (e.g., “userId eq ‘12345’” or “endDate ge datetime’2024-01-01T00:00:00’”)
string
Comma-separated list of fields to retrieve via OData $select parameter. If not specified, all fields are returned.
string
OData $orderby expression for sorting results (e.g., “endDate desc” or “userId asc”)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SAP_SUCCESSFACTORS_GET_EMPLOYEE_TIMERetrieves employee time entries including time off records from SAP SuccessFactors. Use when you need to query approved leaves, time-off requests, or employee time tracking data. Supports filtering by userId, approvalStatus, timeType, and date ranges.

Input Parameters

integer
Maximum number of records to return (OData $top)
integer
Number of records to skip for pagination (OData $skip)
string
OData $filter expression to filter employee time entries. Common filters include userId eq ‘value’, approvalStatus eq ‘APPROVED’, timeType eq ‘value’, startDate ge datetime’2024-01-01T00:00:00’
string
Comma-separated list of fields to retrieve via OData $select parameter
string
OData $orderby expression for sorting results

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SAP_SUCCESSFACTORS_GET_EMPLOYEE_TIMESHEETRetrieves employee timesheet records for attendances, overtime, on-call times, and allowances. Use when you need to query employee timesheet data from SAP SuccessFactors.

Input Parameters

integer
Maximum number of records to return (OData $top parameter)
integer
Number of records to skip for pagination (OData $skip parameter)
string
Expand related entities to include in the response (OData $expand parameter). Common navigations: userIdNav, employeeTimeSheetEntry, allowance
string
OData $filter expression to filter timesheet records. Use OData query syntax (e.g., “userId eq ‘user123’” or “startDate ge datetime’2024-01-01T00:00:00’”)
string
Response format (json or xml). Defaults to json
string
Comma-separated list of fields to include in the response (OData $select parameter)
string
OData $orderby expression for sorting results. Specify field name and optionally ‘asc’ or ‘desc’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SAP_SUCCESSFACTORS_GET_EMP_PAY_COMP_NON_RECURRINGTool to retrieve non-recurring pay component information including bonuses and one-time payments from SAP SuccessFactors. Use when you need data about employee bonuses, commissions, or other non-recurring compensation components.

Input Parameters

integer
Maximum number of records to return (OData $top)
integer
Number of records to skip for pagination (OData $skip)
string
Navigation properties to expand via OData $expand parameter
string
OData $filter expression to filter non-recurring pay component records (e.g., userId eq ‘cgrant’, payDate eq datetime’2024-01-15T00:00:00’)
string
Comma-separated list of fields to retrieve (e.g., userId,seqNumber,payComponentCode,amount,currency,payDate)
string
OData $orderby expression for sorting results (e.g., payDate desc)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SAP_SUCCESSFACTORS_GET_EMP_PAY_COMP_RECURRINGTool to retrieve recurring pay component information including salary and benefits data from SAP SuccessFactors. Use when you need to query employee compensation data with recurring payments such as salary, allowances, or benefits. Supports filtering by userId and payComponent code.

Input Parameters

integer
Maximum number of records to return (OData $top)
integer
Number of records to skip for pagination (OData $skip)
string
Navigation properties to expand via OData $expand parameter
string
OData $filter expression to filter recurring pay component records. Typically filter by userId eq ‘value’ and payComponent eq ‘code’ (e.g., userId eq ‘extuser1’ and payComponent eq ‘CAR_DE’)
string
Comma-separated list of fields to retrieve (e.g., userId,payComponent,frequency,paycompvalue,currencyCode)
string
OData $orderby expression for sorting results (e.g., startDate desc)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SAP_SUCCESSFACTORS_GET_FEEDBACK_RECORDS_SERVICE_AVAILABLETool to retrieve continuous feedback records from SAP SuccessFactors Performance and Goals module using OData V4 protocol. Use when you need to query and retrieve feedback data with filtering, sorting, pagination, and field selection capabilities. Supports standard OData v4 query operations for flexible data retrieval.

Input Parameters

integer
Maximum number of feedback records to return (OData $top). Used for pagination.
integer
Number of records to skip (OData $skip). Used with $top for pagination.
boolean
Include total count of records matching the query (OData $count). Ignores $top and $skip.
string
Navigation properties to expand inline (OData $expand). Example: requester,recipient
string
OData $filter expression to filter feedback records. Example: subjectUserId eq ‘user123’ or requesterId eq ‘user456’
string
Comma-separated list of fields to retrieve (OData $select). Reduces data volume by selecting only relevant fields. Example: feedbackId,requestText,responseText
string
Sort expression (OData $orderby). Sort by properties in ascending (asc) or descending (desc) order. Example: requestDate desc

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SAP_SUCCESSFACTORS_GET_FO_BUSINESS_UNITRetrieves foundation object business unit records for organizational structure hierarchy. Use when querying business unit information with support for filtering, sorting, and pagination.

Input Parameters

integer
Maximum number of records to return (OData $top)
integer
Number of records to skip for pagination (OData $skip)
string
Navigation properties to expand (OData $expand)
string
OData $filter expression to filter business unit records
string
Comma-separated list of fields to retrieve (OData $select)
string
OData $orderby expression for sorting results

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SAP_SUCCESSFACTORS_GET_FO_COMPANYRetrieves foundation object company records from SAP SuccessFactors. Returns company information including display_name, legal_name, and entityOID for One Domain Model integration.

Input Parameters

integer
Maximum number of records to return (OData $top parameter)
integer
Number of records to skip for pagination (OData $skip parameter)
string
OData $filter expression to filter companies. Example: “country eq ‘US’”
string
Comma-separated list of fields to retrieve (OData $select parameter). Example: ‘externalCode,displayName,legalName’
string
OData $orderby expression for sorting results. Example: ‘externalCode asc’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SAP_SUCCESSFACTORS_GET_FO_COST_CENTERRetrieves foundation object cost center records for organizational structure. Contains cost center information with entityOID for One Domain Model integration. Use standard OData query parameters to filter, sort, and paginate results.

Input Parameters

integer
Maximum number of records to return (OData $top parameter)
integer
Number of records to skip for pagination (OData $skip parameter)
string
OData $expand parameter to include related entities in the response
string
OData $filter expression to filter cost center records. Example: “startDate le datetime’2024-12-31’”
string
Comma-separated list of fields to retrieve (OData $select parameter). Example: “externalCode,name,description”
string
OData $orderby expression for sorting results. Example: “externalCode asc” or “lastModifiedDateTime desc”

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SAP_SUCCESSFACTORS_GET_FO_DEPARTMENTTool to retrieve foundation object department records from SAP SuccessFactors. Use when you need to access organizational department structure information including team and group details.

Input Parameters

integer
Maximum number of records to return (OData $top parameter). Must be between 1 and 1000.
integer
Number of records to skip for pagination (OData $skip parameter). Use with ‘top’ for pagination.
string
OData $filter expression to filter department records. Example: “status eq ‘A’” or “startDate gt datetime’2023-01-01T00:00:00’”
string
Comma-separated list of fields to retrieve (OData $select parameter). If not specified, all fields are returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SAP_SUCCESSFACTORS_GET_FO_JOB_CODERetrieves foundation object job code records containing job classification information. Use when you need to fetch job codes with their associated metadata for positions.

Input Parameters

integer
Maximum number of records to return (OData $top parameter)
integer
Number of records to skip for pagination (OData $skip parameter)
string
OData $filter expression to filter job code records. Example: startDate eq datetime’2024-01-01T00:00:00’
string
Comma-separated list of fields to retrieve (OData $select parameter)
string
OData $orderby expression for sorting results. Example: startDate desc

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SAP_SUCCESSFACTORS_GET_FO_JOB_FUNCTIONTool to retrieve foundation object job function records for categorizing job roles. Use when you need to query job function data with support for filtering, field selection, and pagination via OData query options.

Input Parameters

integer
Maximum number of records to return (OData $top). Default is 100.
integer
Number of records to skip for pagination (OData $skip). Use with $top for pagination.
string
OData $filter expression to filter job function records (e.g., “status eq ‘ACTIVE’” or “externalCode eq ‘JF001’”)
string
Comma-separated list of fields to retrieve (OData $select). If not specified, all fields are returned.
string
OData $orderby expression for sorting results (e.g., “name asc” or “externalCode desc”)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SAP_SUCCESSFACTORS_GET_FO_LOCATIONTool to retrieve foundation object location records for work locations. Use when you need to query organizational location data including names, status, timezones, and address details.

Input Parameters

integer
Maximum number of location records to return (OData $top parameter)
string
Expand navigation properties like addressNavDEFLT to include related address details (OData $expand parameter)
string
OData filter expression to filter location records (e.g., “externalCode eq ‘Seoul’” or “status eq ‘A’”)
string
Comma-separated list of fields to return (OData $select parameter, e.g., “externalCode,name,status,startDate”)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SAP_SUCCESSFACTORS_GET_FO_PAY_GROUPRetrieves foundation object pay group records for compensation and payroll groupings. Use when querying pay group data from SAP SuccessFactors.

Input Parameters

integer
Maximum number of records to return (OData $top parameter)
integer
Number of records to skip for pagination (OData $skip parameter)
string
OData $filter expression to filter pay groups. Example: ‘status eq “ACTIVE”’
string
Comma-separated list of fields to retrieve (OData $select parameter)
string
OData $orderby expression for sorting results. Example: ‘externalCode asc’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SAP_SUCCESSFACTORS_GET_FORM_CONTENTRetrieves performance form content from SAP SuccessFactors. Use to query forms with filters like form template ID or modification date.

Input Parameters

integer
Maximum number of records to return (OData $top). Maximum value is 1000.
integer
Number of records to skip for pagination (OData $skip)
string
OData $filter expression to filter form content. Common filters include formTemplateId eq ‘value’ or lastModifiedDateTime gt datetime’2024-01-01T00:00:00’
string
Comma-separated list of fields to retrieve (OData $select)
string
OData $orderby expression for sorting results

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SAP_SUCCESSFACTORS_GET_GOAL_PLAN_TEMPLATERetrieves goal plan template information from SAP SuccessFactors. Use when you need to fetch goal plan template configurations that define the structure of goals via DTD file.

Input Parameters

integer
Maximum number of records to return (OData $top parameter)
integer
Number of records to skip for pagination (OData $skip parameter)
string
Navigation properties to expand (OData $expand parameter)
string
OData $filter expression to filter goal plan templates (e.g., ‘id eq 11’)
string
Comma-separated list of fields to retrieve (OData $select parameter)
string
OData $orderby expression for sorting results (e.g., ‘name asc’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SAP_SUCCESSFACTORS_GET_GOALS_BY_PLANRetrieves performance goals data using the goal plan ID. Use this to query goals for a specific plan (e.g., Goal_11) with optional filtering by userId or other fields.

Input Parameters

integer
Maximum number of records to return (OData $top parameter)
integer
Number of records to skip for pagination (OData $skip parameter)
string
OData $filter expression to filter goals (e.g., “userId eq ‘user123’”)
string
Comma-separated list of fields to retrieve via OData $select parameter
string
required
Goal plan ID to retrieve goals for (e.g., ‘11’, ‘9’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SAP_SUCCESSFACTORS_GET_INTERVIEW_OVERALL_ASSESSMENTRetrieve overall interview assessment records from Interview Central, including ratings, recommendations, and comments.

Input Parameters

integer
Maximum number of records to return (OData $top parameter)
integer
Number of records to skip for pagination (OData $skip parameter)
string
Navigation properties to expand (OData $expand parameter)
string
OData $filter expression to filter interview assessment records
string
Comma-separated list of fields to retrieve (OData $select parameter)
string
OData $orderby expression for sorting results

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SAP_SUCCESSFACTORS_GET_JOB_APPLICATIONRetrieves job application records linking candidates to job requisitions. Use when you need to query application data, filter by status, or retrieve candidate application information.

Input Parameters

integer
Maximum number of records to return (OData $top parameter)
integer
Number of records to skip for pagination (OData $skip parameter)
string
Navigation properties to expand (OData $expand parameter). Example: jobRequisition,candidate
string
OData $filter expression to filter job applications. Example: applicationId eq ‘12345’ or status ne ‘4’
string
Comma-separated list of fields to retrieve (OData $select parameter). Example: applicationId,candidateId,jobReqId,firstName,lastName
string
OData $orderby expression for sorting results. Example: applicationId desc

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SAP_SUCCESSFACTORS_GET_JOB_REQ_SCREENING_QUESTIONTool to retrieve screening questions related to job requisitions from SAP SuccessFactors Recruiting. Use when you need to access screening questions for candidate assessment in the recruitment process.

Input Parameters

integer
Maximum number of screening question records to return (OData $top parameter). Limits the result set size.
integer
Number of records to skip for pagination (OData $skip parameter). Use with $top for pagination.
string
OData $filter expression to filter screening questions. Example: “jobReqId eq 12345” or “locale eq ‘en_US’”
string
Comma-separated list of fields to retrieve (OData $select parameter). Example: ‘jobReqId,locale,order,questionId,questionName,questionType’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SAP_SUCCESSFACTORS_GET_JOB_REQUISITIONTool to retrieve job requisition records from SAP SuccessFactors Recruiting Management. Use when you need to read job requisitions, send them to third-party systems, or manage the recruiting workflow.

Input Parameters

integer
Maximum number of job requisition records to return (OData $top parameter). Limits the result set size.
string
Comma-separated list of navigation properties to expand (OData $expand parameter). Use to expand values from picklist fields such as the label and id. Example: ‘status,location’
string
OData $filter expression to filter job requisitions. Example: “status eq ‘Open’” or “city eq ‘New York’”
string
Response format. Use ‘json’ for JSON format (OData $format parameter).
string
Comma-separated list of fields to retrieve (OData $select parameter). Example: ‘jobReqId,jobCode,jobRole,city,department’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SAP_SUCCESSFACTORS_GET_ODATA_METADATA_CALIB_SESSION_SERVICEGet the entity sets listed in the Calibration Session service’s OData metadata, along with the metadata URL and ETag when available.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SAP_SUCCESSFACTORS_GET_ODATA_METADATA_CLOCK_INCLOCK_OUTGet OData metadata for Clock In/Clock Out Integration service. Returns the complete service schema including entity types, enum types, complex types, and entity container definitions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SAP_SUCCESSFACTORS_GET_ODATA_METADATA_FOR_NOMINATION_SERVICEGet OData metadata for Nomination service. Returns the service metadata including available entity sets for successor and talent pool nominations. Use this to discover available entities in the NominationService.svc service.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SAP_SUCCESSFACTORS_GET_ODATA_METADATA_ONBOARDING_ADDLGet OData metadata for Onboarding Additional Services. Returns the complete service schema including available operations like updateUserNamePostHiring and getUserNameOfNewlyHiredEmployee.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SAP_SUCCESSFACTORS_GET_ODATA_USER_METADATARetrieves the OData metadata document for the User entity describing its properties and operations. Use this to discover available fields, data types, and navigation properties for the User entity.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SAP_SUCCESSFACTORS_GET_ONB2_PROCESSTool to retrieve Onboarding 2.0 process records for new hires from SAP SuccessFactors using OData V2 protocol. Use when you need to query onboarding workflow information with filtering, sorting, and field selection capabilities.

Input Parameters

integer
Maximum number of records to return (OData $top). Used for pagination.
integer
Number of records to skip (OData $skip). Used with $top for pagination.
string
Navigation properties to expand inline (OData $expand). Example: user,manager
string
OData $filter expression to filter onboarding process records. Example: processStatus eq ‘CANCELLED’ or processType eq ‘ONBOARDING’
string
Comma-separated list of fields to retrieve (OData $select). Example: processId,processStatus,user,manager
string
Sort expression (OData $orderby). Sort by properties in ascending (asc) or descending (desc) order. Example: createdDateTime desc

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SAP_SUCCESSFACTORS_GET_PENDING_FEEDBACK_REQUESTS_FEEDBACKTool to retrieve pending feedback requests or feedback request records from SAP SuccessFactors Continuous Feedback. Use when you need to query feedback requests with filtering, sorting, pagination, and field selection capabilities. Supports standard OData v4 query operations for flexible data retrieval.

Input Parameters

integer
Maximum number of feedback request records to return (OData $top). Used for pagination.
integer
Number of records to skip (OData $skip). Used with $top for pagination.
boolean
Include total count of records matching the query (OData $count). Set to true to get count.
string
Navigation properties to expand inline (OData $expand). Example: feedback,activities
string
OData $filter expression to filter feedback requests. Example: status eq ‘PENDING’ or requesterAssignmentUUID eq ‘uuid’
string
Comma-separated list of fields to retrieve (OData $select). Reduces data volume by selecting only relevant fields. Example: feedbackRequestId,status,topic
string
Sort expression (OData $orderby). Sort by properties in ascending (asc) or descending (desc) order. Example: createdDate desc

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SAP_SUCCESSFACTORS_GET_PER_PERSONALTool to retrieve personal information records from SAP SuccessFactors Employee Central. The PerPersonal entity contains non-effective-dated biographical information, emergency contacts, social media accounts, and email addresses. Use when you need to access personal information data.

Input Parameters

integer
Maximum number of records to return (OData $top). Default is 100.
integer
Number of records to skip for pagination (OData $skip). Use with $top for pagination.
string
Navigation properties to expand (OData $expand), such as emergencyContactNav, emailNav, phoneNav
string
OData $filter expression to filter records (e.g., “personIdExternal eq ‘12345’” or “UserID ne null”)
string
Comma-separated list of fields to retrieve via OData $select parameter. If not specified, all fields are returned.
string
OData $orderby expression for sorting results (e.g., “personIdExternal asc” or “lastModifiedOn desc”)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SAP_SUCCESSFACTORS_GET_PER_PERSON_BY_IDTool to retrieve person information for an employee by their external person ID. Use when you need to access core personal information data from SAP SuccessFactors Employee Central PerPerson entity.

Input Parameters

string
Navigation properties to expand (OData $expand), such as personalInfoNav, employmentNav, emailNav, phoneNav
string
Comma-separated list of fields to retrieve via OData $select parameter
string
required
The external person ID for the employee

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SAP_SUCCESSFACTORS_GET_PICKLISTTool to retrieve picklist definitions from SAP SuccessFactors. Use when you need to fetch selectable value lists (picklists) that are used across various SuccessFactors entities.

Input Parameters

integer
Maximum number of picklists to return (OData $top parameter)
integer
Number of records to skip for pagination (OData $skip parameter)
string
Navigation properties to expand (OData $expand parameter, e.g., ‘picklistOptions’ to include picklist options)
string
OData $filter expression to filter picklists (e.g., “picklistId eq ‘employee-type’”)
string
Comma-separated list of fields to retrieve (OData $select parameter)
string
OData $orderby expression for sorting results (e.g., ‘picklistId asc’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SAP_SUCCESSFACTORS_GET_PICKLIST_OPTIONRetrieves picklist option values with localized labels from SAP SuccessFactors. Use the localeLabel property to get text in the locale of the logged-in user. Supports OData query parameters for filtering, selection, and pagination.

Input Parameters

integer
Maximum number of records to return (OData $top parameter)
integer
Number of records to skip for pagination (OData $skip parameter)
string
Navigation properties to expand (OData $expand parameter)
string
OData $filter expression to filter picklist options. Example: picklistId eq ‘your_picklist_id’
string
Comma-separated list of fields to retrieve (OData $select parameter). Example: id,externalCode,localeLabel,picklistId
string
OData $orderby expression for sorting results. Example: sortOrder asc

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SAP_SUCCESSFACTORS_GET_POSITIONRetrieves position management records from SAP SuccessFactors Employee Central. Use when you need to query position structure and hierarchy information.

Input Parameters

integer
Maximum number of records to return (OData $top parameter)
string
Navigation properties to expand in the response. Example: “jobCode,department”
string
OData $filter expression for filtering Position records. Example: “code eq ‘P123’” or “effectiveStartDate ge datetime’2024-01-01T00:00:00’”
string
Response format (json or xml). Defaults to json
string
Set to ‘snapshot’ for snapshot-based pagination to handle large result sets
string
Comma-separated list of fields to return. Example: “code,positionTitle,effectiveStartDate”

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SAP_SUCCESSFACTORS_GET_TALENT_POOLRetrieve talent pool records for succession planning, with optional filtering, selection and pagination.

Input Parameters

integer
Maximum number of records to return (OData $top)
integer
Number of records to skip for pagination (OData $skip)
string
Navigation properties to expand for related data (OData $expand)
string
OData $filter expression to filter talent pools (e.g., “Status eq ‘A’” for active pools)
string
Comma-separated list of fields to retrieve (OData $select)
string
OData $orderby expression for sorting results

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SAP_SUCCESSFACTORS_GET_TEMPORARY_TIME_INFORMATIONRetrieves temporary time information records from Time Management module. Use when you need to query temporary work schedules assigned to employees.

Input Parameters

integer
Maximum number of records to return (OData $top parameter)
integer
Number of records to skip for pagination (OData $skip parameter)
string
OData $filter expression to filter temporary time information records. Example: userId eq ‘user123’ or startDate ge datetime’2024-01-01T00:00:00’
string
Comma-separated list of fields to retrieve (OData $select parameter). Example: externalCode,userId,startDate,endDate,workSchedule
string
OData $orderby expression for sorting results. Example: startDate desc

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SAP_SUCCESSFACTORS_GET_TIME_ACCOUNT_SNAPSHOTRetrieves time account snapshot data for leave liability calculation and payroll. Use when you need balance information for employee time accounts as of a specific point in time.

Input Parameters

integer
Maximum number of records to return (OData $top parameter)
integer
Number of records to skip for pagination (OData $skip parameter)
string
OData $filter expression to filter time account snapshots. Examples: userId eq ‘jsmith’, externalCode eq ‘SNAPSHOT001’, accountId eq ‘VACATION’
string
Comma-separated list of fields to retrieve (OData $select parameter). Examples: userId,externalCode,accountId,balance
string
OData $orderby expression for sorting results. Examples: snapshotDate desc, userId asc

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SAP_SUCCESSFACTORS_GET_WORK_ORDERTool to retrieve work order records for contingent worker management from SAP SuccessFactors. Use when you need to query work order information with support for filtering, field selection, and pagination via OData query options.

Input Parameters

integer
Maximum number of records to return (OData $top). Default is 100.
integer
Number of records to skip for pagination (OData $skip). Use with $top for pagination.
string
Navigation properties to expand in the response (OData $expand). Example: “userSysIdNav” to include user details.
string
OData $filter expression to filter WorkOrder records (e.g., “userSysId eq ‘1234’” or “startDate ge datetime’2024-01-01T00:00:00’”)
string
Comma-separated list of fields to retrieve (OData $select). If not specified, all fields are returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SAP_SUCCESSFACTORS_GIVE_OR_RESPOND_FEEDBACKTool to give performance feedback or respond to a feedback request in SAP SuccessFactors Continuous Performance Management. Use when you need to provide feedback on employee performance, strengths, development areas, or respond to existing feedback requests. Supports up to 3 question-answer pairs with extended field lengths (4000 characters per answer).

Input Parameters

string
required
Topic of the feedback (e.g., ‘Performance Feedback’, ‘Development Areas’)
string
required
Answer to the first question (max 4000 characters)
string
Answer to the second question (optional, max 4000 characters)
string
Answer to the third question (optional, max 4000 characters)
string
required
First question for the feedback
string
Second question for the feedback (optional)
string
Third question for the feedback (optional)
boolean
Whether the feedback should be visible to the manager
string
Record ID of the feedback request being responded to (only needed when responding to an existing feedback request)
string
required
UUID of the user giving the feedback (must be the authenticated user)
string
required
UUID of the user receiving the feedback

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SAP_SUCCESSFACTORS_LIST_CANDIDATESTool to retrieve a list of candidates from SAP SuccessFactors. Use when you need to query candidate data with OData filtering and pagination options.

Input Parameters

integer
Maximum number of candidates to return (OData $top parameter). Use for pagination.
integer
Number of candidates to skip for pagination (OData $skip parameter).
string
OData $filter expression to filter candidates (e.g., “status eq ‘Active’” or “lastName eq ‘Smith’”).
string
Comma-separated list of fields to retrieve (OData $select parameter). If not specified, all fields are returned.
string
OData $orderby expression for sorting results (e.g., “lastName asc” or “createdDate desc”).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SAP_SUCCESSFACTORS_LIST_EMP_EMPLOYMENTTool to retrieve a list of all employment records from SAP SuccessFactors. Use when you need to query employment data including start dates, employment types, and assignment classes. Supports filtering by custom string fields (custom-string1, custom-string2, custom-string3) and userId.

Input Parameters

integer
Maximum number of records to return (OData $top)
integer
Number of records to skip for pagination (OData $skip)
string
Navigation properties to expand via OData $expand parameter
string
OData $filter expression to filter employment records (e.g., userId eq ‘109031’, custom-string1 eq ‘value’)
string
Comma-separated list of fields to retrieve (e.g., employmentId,userId,startDate,employmentType)
string
OData $orderby expression for sorting results (e.g., startDate desc)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SAP_SUCCESSFACTORS_LIST_PER_PERSONTool to retrieve a list of person records from SAP SuccessFactors Employee Central. Use when you need to query employee personal information. The PerPerson entity is the foundation for all employee data in Employee Central and always returns the latest active record for each person.

Input Parameters

integer
Maximum number of person records to return (OData $top parameter). Use for pagination.
integer
Number of records to skip for pagination (OData $skip parameter). Use with $top for paging through results.
string
OData $filter expression to filter person records. Example: “personIdExternal eq ‘jsmith’” or “startDate gt datetime’2024-01-01T00:00:00’”.
string
Comma-separated list of fields to retrieve (OData $select parameter). Example: “personIdExternal,firstName,lastName,dateOfBirth”.
string
OData $orderby expression for sorting results. Example: “personIdExternal asc” or “startDate desc”.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SAP_SUCCESSFACTORS_LIST_USERSTool to retrieve a list of all employee users from SAP SuccessFactors. Use when you need to query user information with support for filtering, field selection, and pagination via OData query options.

Input Parameters

integer
Maximum number of records to return (OData $top). Note: This API may have restrictions on using $top parameter.
integer
Number of records to skip for pagination (OData $skip). Use with $top for pagination.
string
OData $filter expression to filter users (e.g., “username eq ‘johndoe’” or “status eq ‘active’”)
string
Comma-separated list of fields to retrieve (OData $select). If not specified, all fields are returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SAP_SUCCESSFACTORS_QUERY_ALL_AVAILABLE_CLOCK_CLOCK_OUTQuery all available clock in/clock out groups. Use when you need to retrieve a list of all clock in/clock out groups configured in SAP SuccessFactors.

Input Parameters

integer
Maximum number of records to return (OData $top)
integer
Number of records to skip for pagination (OData $skip)
string
OData $filter expression to filter clock in/out groups
string
Comma-separated list of fields to retrieve (OData $select)
string
OData $orderby expression for sorting results

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SAP_SUCCESSFACTORS_QUERY_CLOCK_CLOCK_OUT_GROUP_CODE_TIMEQuery a clock in/clock out group by code to retrieve its configuration details. The returned fields do not include related time event types, even when requested through expansion.

Input Parameters

string
required
The unique identifier code for the Clock In Clock Out Group to retrieve (e.g., ‘TETG-1’, ‘Group1’)
string
OData $expand parameter to include related entities. Use ‘timeEventTypeNav’ to expand related Time Event Types
string
Comma-separated list of fields to retrieve (OData $select)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SAP_SUCCESSFACTORS_REFRESH_CDP_LEARNING_METADATARefresh metadata for Career Development Planning Learning service.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SAP_SUCCESSFACTORS_REFRESH_METADATA_CONT_FEEDBACK_SERVICERefresh metadata cache for Continuous Feedback service. Use when metadata changes need to be applied without service interruption.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SAP_SUCCESSFACTORS_UPDATE_CALIBRATION_SUBJECT_RATINGSUpdate the calibrated status of a subject in a calibration session.

Input Parameters

boolean
Mark subject as calibrated
string
required
The calibration session ID
string
required
The subject ID to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SAP_SUCCESSFACTORS_UPDATE_INTERNAL_USERNAME_NEW_HIRES_AFTERUpdate a new hire’s internal username using a supplied username after the hiring process is completed. Use after Manage Pending Hire submit and before day 1 (pre-conversion); the operation requires the Manage Onboarding 2.0 or Offboarding 2.0 Update New Hire Data for External HRIS permission.

Input Parameters

string
required
The unique identifier of the user/new hire whose username needs to be updated
string
required
The new username to be assigned to the user, typically generated from Active Directory. This will be the internal username field that gets updated.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not