API - Employee Profile Scopes

Modified on Sun, 14 Dec, 2025 at 8:43 PM

Applicable packages Leave Time HR Essentials HR Success


Required Roles Team Manager HR Manager Administrator ADU Manager



The Employee Profiles API allows you to read Employee Profile data from Appogee HR. 


The API response includes data from all fields in the HR profile, as defined in Profile > Admin & Config > Record Categories & Fields. 


By default, custom fields are labeled "custom1", "custom2" etc. For ease of use, you can rename the labels. 


To do this, go to Profile > Admin & Config > Record Categories & Fields > click on a category > Fields & Security. 


Switch to Edit mode and click on "Show Field IDs?". 



Underneath each field, you will see the API Field ID. Any Custom Fields can be renamed by clicking on the pencil. 


Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select at least one of the reasons
CAPTCHA verification is required.

Feedback sent

We appreciate your effort and will try to fix the article