sap-success-factors-look-up-employee-details implementation guide

---
availability: INSTALLABLE
description: A plugin that enables HR team members to instantly retrieve employee
  information from SAP SuccessFactors without logging into the HR portal. Employees
  can be searched by name, email, manager, or department, with quick access to important
  details like role, department, division, manager, location, etc.
installation_asset_uuid: 56616cff-efc7-4d80-9b3b-98a4bd03846b
name: Look Up Employee Information
purple_chat_link: https://marketplace.moveworks.com/purple-chat?conversation=%7B%22messages%22%3A%5B%7B%22role%22%3A%22user%22%2C%22parts%22%3A%5B%7B%22richText%22%3A%22I+want+to+look+up+details+of+an+employee%22%7D%5D%7D%2C%7B%22role%22%3A%22assistant%22%2C%22parts%22%3A%5B%7B%22richText%22%3A%22To+look+up+details+of+an+employee%2C+please+let+me+know+how+you+want+to+search+for+them.+Here+are+your+options%3A+%3Col+xmlns%3D%5C%22http%3A%2F%2Fwww.w3.org%2F1999%2Fxhtml%5C%22%3E%3Cli%3E%3Cb%3EBy+employee+name%3C%2Fb%3E%3C%2Fli%3E%3Cli%3E%3Cb%3EBy+employee+email%3C%2Fb%3E%3C%2Fli%3E%3Cli%3E%3Cb%3EBy+employees+reporting+to+a+manager%3C%2Fb%3E%3C%2Fli%3E%3Cli%3E%3Cb%3EBy+employees+in+a+department%3C%2Fb%3E%3C%2Fli%3E%3C%2Fol%3E%3Cb+xmlns%3D%5C%22http%3A%2F%2Fwww.w3.org%2F1999%2Fxhtml%5C%22%3EWhich+option+would+you+like+to+use%3F%3C%2Fb%3E%22%7D%5D%7D%2C%7B%22role%22%3A%22user%22%2C%22parts%22%3A%5B%7B%22richText%22%3A%22I+want+to+view+Charles+Braun%27s+reportees%22%7D%5D%7D%2C%7B%22role%22%3A%22assistant%22%2C%22parts%22%3A%5B%7B%22reasoningSteps%22%3A%5B%7B%22status%22%3A%22success%22%2C%22richText%22%3A%22Searching+for+direct+reportees+of+%3Cb+xmlns%3D%5C%22http%3A%2F%2Fwww.w3.org%2F1999%2Fxhtml%5C%22%3ECharles+Braun%3C%2Fb%3E+in+%3Cb+xmlns%3D%5C%22http%3A%2F%2Fwww.w3.org%2F1999%2Fxhtml%5C%22%3ESAP+SuccessFactors%3C%2Fb%3E.%22%7D%5D%7D%2C%7B%22richText%22%3A%22%3Cp+xmlns%3D%5C%22http%3A%2F%2Fwww.w3.org%2F1999%2Fxhtml%5C%22%3EHere+are+the+reportees+found+for+Charles+Braun%3A%3Cbr+%2F%3E1.+Ana+Lovelace+%E2%80%93+Integration+Administrator%2C+Global+Human+Resources%3Cbr+%2F%3E2.+June+Headley+%E2%80%93+Automation+Administrator%2C+Global+Human+Resources%3Cbr+%2F%3E3.+Tessa+Walker+%E2%80%93+HR+Business+Partner+Global%2C+Human+Resources+US%3Cbr+%2F%3E4.+Emilio+Branson+%E2%80%93+Decentralised+Administrator%2C+Global+Human+Resources+Please+let+me+know+if+you+want+detailed+information+about+any+specific+reportee+from+this+list.+Just+reply+with+the+name+or+the+number+from+the+list+above%21%3C%2Fp%3E%22%7D%2C%7B%22citations%22%3A%5B%7B%22connectorName%22%3A%22sap-successfactors%22%2C%22citationTitle%22%3A%22Ana+Lovelace%22%7D%2C%7B%22connectorName%22%3A%22sap-successfactors%22%2C%22citationTitle%22%3A%22June+Headley%22%7D%2C%7B%22connectorName%22%3A%22sap-successfactors%22%2C%22citationTitle%22%3A%22Tessa+Walker%22%7D%2C%7B%22connectorName%22%3A%22sap-successfactors%22%2C%22citationTitle%22%3A%22Emilio+Branson%22%7D%5D%7D%5D%7D%2C%7B%22role%22%3A%22user%22%2C%22parts%22%3A%5B%7B%22richText%22%3A%22Emilio+Branson%22%7D%5D%7D%2C%7B%22role%22%3A%22assistant%22%2C%22parts%22%3A%5B%7B%22reasoningSteps%22%3A%5B%7B%22status%22%3A%22success%22%2C%22richText%22%3A%22Retrieving+detailed+employee+information+for+%3Cb+xmlns%3D%5C%22http%3A%2F%2Fwww.w3.org%2F1999%2Fxhtml%5C%22%3EEmilio+Branson%3C%2Fb%3E+from+%3Cb+xmlns%3D%5C%22http%3A%2F%2Fwww.w3.org%2F1999%2Fxhtml%5C%22%3ESAP+SuccessFactors%3C%2Fb%3E.%22%7D%5D%7D%2C%7B%22richText%22%3A%22%3Cp%3EHere+are+the+resolved+details+for+Charles+Braun%27s+reportee+you+selected%3A%3C%2Fp%3E%3Ch3%3E%3Cstrong%3EEmployee+Details%3A+Emilio+Branson%3C%2Fstrong%3E%3C%2Fh3%3E%3Cul%3E%3Cli%3E%3Cp%3E%3Cstrong%3EDisplay+Name%3A%3C%2Fstrong%3E+Emilio+Branson%3C%2Fp%3E%3C%2Fli%3E%3C%2Ful%3E%3Cul%3E%3Cli%3E%3Cp%3E%3Cstrong%3ETitle%3A%3C%2Fstrong%3E+Decentralised+Administrator%3C%2Fp%3E%3C%2Fli%3E%3C%2Ful%3E%3Cul%3E%3Cli%3E%3Cp%3E%3Cstrong%3EDepartment%3A%3C%2Fstrong%3E+Global+Human+Resources+%2850007726%29%3C%2Fp%3E%3C%2Fli%3E%3C%2Ful%3E%3Cul%3E%3Cli%3E%3Cp%3E%3Cstrong%3EDivision%3A%3C%2Fstrong%3E+Corporate+Services+%28CORP_SVCS%29%3C%2Fp%3E%3C%2Fli%3E%3C%2Ful%3E%3Cul%3E%3Cli%3E%3Cp%3E%3Cstrong%3ELocation%3A%3C%2Fstrong%3E+Corporate+-+US-Philadelphia+%281710-2001%29%3C%2Fp%3E%3C%2Fli%3E%3C%2Ful%3E%3Cul%3E%3Cli%3E%3Cp%3E%3Cstrong%3ECountry%3A%3C%2Fstrong%3E+United+States%3C%2Fp%3E%3C%2Fli%3E%3C%2Ful%3E%3Cul%3E%3Cli%3E%3Cp%3E%3Cstrong%3EEmail%3A%3C%2Fstrong%3E+%3Ca+target%3D%5C%22_blank%5C%22+rel%3D%5C%22noopener+noreferrer+nofollow%5C%22+class%3D%5C%22editor-link%5C%22+href%3D%5C%22mailto%3Aemilio.branson%40bestrunsap.com%5C%22%3Eemilio.branson%40bestrunsap.com%3C%2Fa%3E%3C%2Fp%3E%3C%2Fli%3E%3C%2Ful%3E%3Cul%3E%3Cli%3E%3Cp%3E%3Cstrong%3EUsername%3A%3C%2Fstrong%3E+D_ADMIN%3C%2Fp%3E%3C%2Fli%3E%3C%2Ful%3E%3Cul%3E%3Cli%3E%3Cp%3E%3Cstrong%3EManager%3A%3C%2Fstrong%3E+Charles+Braun%3C%2Fp%3E%3C%2Fli%3E%3C%2Ful%3E%3Cul%3E%3Cli%3E%3Cp%3E%3Cstrong%3EManager+Email%3A%3C%2Fstrong%3E+%3Ca+target%3D%5C%22_blank%5C%22+rel%3D%5C%22noopener+noreferrer+nofollow%5C%22+class%3D%5C%22editor-link%5C%22+href%3D%5C%22mailto%3ACharles.braun%40bestrunsap.com%5C%22%3ECharles.braun%40bestrunsap.com%3C%2Fa%3E%3C%2Fp%3E%3C%2Fli%3E%3C%2Ful%3E%3Cul%3E%3Cli%3E%3Cp%3E%3Cstrong%3EStatus%3A%3C%2Fstrong%3E+Active%3C%2Fp%3E%3C%2Fli%3E%3C%2Ful%3E%3Cul%3E%3Cli%3E%3Cp%3E%3Cstrong%3EGender%3A%3C%2Fstrong%3E+Male%3C%2Fp%3E%3C%2Fli%3E%3C%2Ful%3E%3Cul%3E%3Cli%3E%3Cp%3E%3Cstrong%3EDate+of+Birth%3A%3C%2Fstrong%3E+7+April+1996%3C%2Fp%3E%3C%2Fli%3E%3C%2Ful%3E%3Cul%3E%3Cli%3E%3Cp%3E%3Cstrong%3EHire+Date%3A%3C%2Fstrong%3E+1+January+2021%3C%2Fp%3E%3C%2Fli%3E%3C%2Ful%3E%3Cp%3EIf+you+need+more+information+or+want+details+about+another+reportee%2C+just+let+me+know%21%3C%2Fp%3E%22%7D%5D%7D%5D%7D
solution_tags:
- HR - Employee Records
- HR - Other
systems:
- sap-success-factors
---

# **Introduction**

The **Look Up Employee Information** plugin allows HR team members to instantly access employee details from **SAP SuccessFactors** directly through the Moveworks AI Assistant. Users can search by a partially matching name, email, employee ID, or department to quickly retrieve key information such as role, department, division, manager, location, hire date, and employment status. This eliminates the need to log into the SAP portal, giving HR teams fast, accurate, and convenient access to employee records whenever they need them.

This guide will help you install this plugin within minutes in Agent Studio. Let’s get started!

# **Prerequisites**

- Access to Agent Studio

# **What are we building?**

# **Agent Design**

This [**purple chat**](https://marketplace.moveworks.com/purple-chat?conversation=%7B%22messages%22%3A%5B%7B%22role%22%3A%22user%22%2C%22parts%22%3A%5B%7B%22richText%22%3A%22I+want+to+look+up+details+of+an+employee%22%7D%5D%7D%2C%7B%22role%22%3A%22assistant%22%2C%22parts%22%3A%5B%7B%22richText%22%3A%22To+look+up+details+of+an+employee%2C+please+let+me+know+how+you+want+to+search+for+them.+Here+are+your+options%3A+%3Col+xmlns%3D%5C%22http%3A%2F%2Fwww.w3.org%2F1999%2Fxhtml%5C%22%3E%3Cli%3E%3Cb%3EBy+employee+name%3C%2Fb%3E%3C%2Fli%3E%3Cli%3E%3Cb%3EBy+employee+email%3C%2Fb%3E%3C%2Fli%3E%3Cli%3E%3Cb%3EBy+employees+reporting+to+a+manager%3C%2Fb%3E%3C%2Fli%3E%3Cli%3E%3Cb%3EBy+employees+in+a+department%3C%2Fb%3E%3C%2Fli%3E%3C%2Fol%3E%3Cb+xmlns%3D%5C%22http%3A%2F%2Fwww.w3.org%2F1999%2Fxhtml%5C%22%3EWhich+option+would+you+like+to+use%3F%3C%2Fb%3E%22%7D%5D%7D%2C%7B%22role%22%3A%22user%22%2C%22parts%22%3A%5B%7B%22richText%22%3A%22I+want+to+view+Charles+Braun%27s+reportees%22%7D%5D%7D%2C%7B%22role%22%3A%22assistant%22%2C%22parts%22%3A%5B%7B%22reasoningSteps%22%3A%5B%7B%22status%22%3A%22success%22%2C%22richText%22%3A%22Searching+for+direct+reportees+of+%3Cb+xmlns%3D%5C%22http%3A%2F%2Fwww.w3.org%2F1999%2Fxhtml%5C%22%3ECharles+Braun%3C%2Fb%3E+in+%3Cb+xmlns%3D%5C%22http%3A%2F%2Fwww.w3.org%2F1999%2Fxhtml%5C%22%3ESAP+SuccessFactors%3C%2Fb%3E.%22%7D%5D%7D%2C%7B%22richText%22%3A%22%3Cp+xmlns%3D%5C%22http%3A%2F%2Fwww.w3.org%2F1999%2Fxhtml%5C%22%3EHere+are+the+reportees+found+for+Charles+Braun%3A%3Cbr+%2F%3E1.+Ana+Lovelace+%E2%80%93+Integration+Administrator%2C+Global+Human+Resources%3Cbr+%2F%3E2.+June+Headley+%E2%80%93+Automation+Administrator%2C+Global+Human+Resources%3Cbr+%2F%3E3.+Tessa+Walker+%E2%80%93+HR+Business+Partner+Global%2C+Human+Resources+US%3Cbr+%2F%3E4.+Emilio+Branson+%E2%80%93+Decentralised+Administrator%2C+Global+Human+Resources+Please+let+me+know+if+you+want+detailed+information+about+any+specific+reportee+from+this+list.+Just+reply+with+the+name+or+the+number+from+the+list+above%21%3C%2Fp%3E%22%7D%2C%7B%22citations%22%3A%5B%7B%22connectorName%22%3A%22sap-successfactors%22%2C%22citationTitle%22%3A%22Ana+Lovelace%22%7D%2C%7B%22connectorName%22%3A%22sap-successfactors%22%2C%22citationTitle%22%3A%22June+Headley%22%7D%2C%7B%22connectorName%22%3A%22sap-successfactors%22%2C%22citationTitle%22%3A%22Tessa+Walker%22%7D%2C%7B%22connectorName%22%3A%22sap-successfactors%22%2C%22citationTitle%22%3A%22Emilio+Branson%22%7D%5D%7D%5D%7D%2C%7B%22role%22%3A%22user%22%2C%22parts%22%3A%5B%7B%22richText%22%3A%22Emilio+Branson%22%7D%5D%7D%2C%7B%22role%22%3A%22assistant%22%2C%22parts%22%3A%5B%7B%22reasoningSteps%22%3A%5B%7B%22status%22%3A%22success%22%2C%22richText%22%3A%22Retrieving+detailed+employee+information+for+%3Cb+xmlns%3D%5C%22http%3A%2F%2Fwww.w3.org%2F1999%2Fxhtml%5C%22%3EEmilio+Branson%3C%2Fb%3E+from+%3Cb+xmlns%3D%5C%22http%3A%2F%2Fwww.w3.org%2F1999%2Fxhtml%5C%22%3ESAP+SuccessFactors%3C%2Fb%3E.%22%7D%5D%7D%2C%7B%22richText%22%3A%22%3Cp%3EHere+are+the+resolved+details+for+Charles+Braun%27s+reportee+you+selected%3A%3C%2Fp%3E%3Ch3%3E%3Cstrong%3EEmployee+Details%3A+Emilio+Branson%3C%2Fstrong%3E%3C%2Fh3%3E%3Cul%3E%3Cli%3E%3Cp%3E%3Cstrong%3EDisplay+Name%3A%3C%2Fstrong%3E+Emilio+Branson%3C%2Fp%3E%3C%2Fli%3E%3C%2Ful%3E%3Cul%3E%3Cli%3E%3Cp%3E%3Cstrong%3ETitle%3A%3C%2Fstrong%3E+Decentralised+Administrator%3C%2Fp%3E%3C%2Fli%3E%3C%2Ful%3E%3Cul%3E%3Cli%3E%3Cp%3E%3Cstrong%3EDepartment%3A%3C%2Fstrong%3E+Global+Human+Resources+%2850007726%29%3C%2Fp%3E%3C%2Fli%3E%3C%2Ful%3E%3Cul%3E%3Cli%3E%3Cp%3E%3Cstrong%3EDivision%3A%3C%2Fstrong%3E+Corporate+Services+%28CORP_SVCS%29%3C%2Fp%3E%3C%2Fli%3E%3C%2Ful%3E%3Cul%3E%3Cli%3E%3Cp%3E%3Cstrong%3ELocation%3A%3C%2Fstrong%3E+Corporate+-+US-Philadelphia+%281710-2001%29%3C%2Fp%3E%3C%2Fli%3E%3C%2Ful%3E%3Cul%3E%3Cli%3E%3Cp%3E%3Cstrong%3ECountry%3A%3C%2Fstrong%3E+United+States%3C%2Fp%3E%3C%2Fli%3E%3C%2Ful%3E%3Cul%3E%3Cli%3E%3Cp%3E%3Cstrong%3EEmail%3A%3C%2Fstrong%3E+%3Ca+target%3D%5C%22_blank%5C%22+rel%3D%5C%22noopener+noreferrer+nofollow%5C%22+class%3D%5C%22editor-link%5C%22+href%3D%5C%22mailto%3Aemilio.branson%40bestrunsap.com%5C%22%3Eemilio.branson%40bestrunsap.com%3C%2Fa%3E%3C%2Fp%3E%3C%2Fli%3E%3C%2Ful%3E%3Cul%3E%3Cli%3E%3Cp%3E%3Cstrong%3EUsername%3A%3C%2Fstrong%3E+D_ADMIN%3C%2Fp%3E%3C%2Fli%3E%3C%2Ful%3E%3Cul%3E%3Cli%3E%3Cp%3E%3Cstrong%3EManager%3A%3C%2Fstrong%3E+Charles+Braun%3C%2Fp%3E%3C%2Fli%3E%3C%2Ful%3E%3Cul%3E%3Cli%3E%3Cp%3E%3Cstrong%3EManager+Email%3A%3C%2Fstrong%3E+%3Ca+target%3D%5C%22_blank%5C%22+rel%3D%5C%22noopener+noreferrer+nofollow%5C%22+class%3D%5C%22editor-link%5C%22+href%3D%5C%22mailto%3ACharles.braun%40bestrunsap.com%5C%22%3ECharles.braun%40bestrunsap.com%3C%2Fa%3E%3C%2Fp%3E%3C%2Fli%3E%3C%2Ful%3E%3Cul%3E%3Cli%3E%3Cp%3E%3Cstrong%3EStatus%3A%3C%2Fstrong%3E+Active%3C%2Fp%3E%3C%2Fli%3E%3C%2Ful%3E%3Cul%3E%3Cli%3E%3Cp%3E%3Cstrong%3EGender%3A%3C%2Fstrong%3E+Male%3C%2Fp%3E%3C%2Fli%3E%3C%2Ful%3E%3Cul%3E%3Cli%3E%3Cp%3E%3Cstrong%3EDate+of+Birth%3A%3C%2Fstrong%3E+7+April+1996%3C%2Fp%3E%3C%2Fli%3E%3C%2Ful%3E%3Cul%3E%3Cli%3E%3Cp%3E%3Cstrong%3EHire+Date%3A%3C%2Fstrong%3E+1+January+2021%3C%2Fp%3E%3C%2Fli%3E%3C%2Ful%3E%3Cp%3EIf+you+need+more+information+or+want+details+about+another+reportee%2C+just+let+me+know%21%3C%2Fp%3E%22%7D%5D%7D%5D%7D) shows the experience we are going to build.

# **Installation Steps**

While you can create a connector during plugin installation, we recommend setting up the connector in **Agent Studio** beforehand to streamline the process. Please follow our [**SAP SuccessFactors Connector Guide**](https://marketplace.moveworks.com/marketplace/package/?id=sap-success-factors&hist=home%2Cbrws#how-to-implement) for detailed instructions. Once completed, proceed to install the plugin and complete the setup efficiently.

For this plugin, ensure the SAP SuccessFactors integration user has the following permissions:

**Required Scopes:**

- **`View`** access to the **User** entity

After configuring the connector, refer to our [**plugin installation documentation**](https://help.moveworks.com/docs/ai-agent-marketplace-installation) for more details on completing the setup.

# **Appendix**

# **API #1: Fetch an Employee’s User Information**

The **Fetch User Information** API retrieves a User’s details based on a given User Attribute Filter (in this case, User Display Name). With this API, you can add filters, display selected fields, and expand on line items within specific fields using query params. 

```bash
curl --request GET \
  --location 'https://<API_SERVER>/odata/v2/User?$filter=displayName%20like%20%27displayName%25%27&$select=userId,username,displayName,email,gender,dateOfBirth,hireDate,country,location,division,department,title,jobLevel,payGrade,status,manager/userId,manager/displayName,manager/email&$expand=manager' \
  --header 'Authorization: Bearer <YOUR_ACCESS_TOKEN>' \
  --header 'Content-Type: application/json' \
  --header 'Accept: application/json'
```

**Query Parameters :**

- $filter (string) ****– Filter items by property values
    - You can filter by email, displayName, manager/displayName, department and other User level properties (filterable: true). This filtering behavior is dynamic across different properties.
        - You can also do a substring match using the `LIKE` operator in query params.
            - For ex: `displayName like 'Ana%'` returns all users whose display name starts with "Ana"
- $select (array[string]) – Select properties to be returned
    - For users, you can display properties like userId, username, firstName, lastName, displayName, email, gender, dateOfBirth, hireDate, etc.
- $expand (string) ****– Additional field to be included to view details like manager/displayName, etc (personal/other info).
- **`optional_fields`**(string) – Specify additional fields to include in the response, such as $top,$skip
- **Important Note**
    - The `$expand` query parameter lets you look up related field, while the `$select` query parameter is used to display specific fields for the expanded fields. To show additional details from an expanded entity, use the format: `<entity_name>/<nested_field_to_be_displayed>`.