How to access employees and users
June 25, 2024
How do you get information on a customer account's users and employees?
The essential idea is that regardless of whether the integration involves an e-commerce, CRM, or accounting application, user information for a corporate account is consistently accessible through our unified HR API. This is achieved using the HR Get Employee and List Employees API endpoints.
GET /hris/{connection_id}/employee
GET /hris/{connection_id}/employee/{id}
There are approximately 120 integrations that support the HR Employee endpoints.
Employee/User IDs in all unified data models
Here is a list of different objects across all our unified API categories that link back to an HR Employee via their IDs. Note: We use the terms 'employee' and 'user' interchangeably.
| Category | Data Model | Field | Description |
|---|---|---|---|
| ATS | Activity | user_ids | The recruiters associated with this activity |
| ATS | Candidate | user_id | The recruiter or hiring manager associated with this candidate |
| ATS | Document | user_id | The user who created this document |
| ATS | Interview | user_ids | The employees that were in this interview |
| ATS | Job | recruiter_ids | |
| ATS | Job | hiring_manager_ids | |
| ATS | Scorecard | interviewer_id | |
| ATS | Company | recruiters_ids | |
| Call Center | Call | user_id | The agent |
| CRM | Company | user_id | The salesperson that is responsible for this company/account |
| CRM | Contact | user_id | The salesperson that is responsible for this contact |
| CRM | Deal | user_id | The salesperson that is responsible for this deal/opportunity |
| CRM | Event | user_id | |
| CRM | Lead | user_id | The salesperson that is responsible for this lead |
| CRM | Lead | creator_user_id | The user that created this lead |
| HR | Employee | manager_id | This user's reporting manager |
| HR | Group | user_ids | The group's members |
| HR | Group | manager_ids | The group's managers |
| HR | Payslip | user_id | The employee that this pay slip pertains to |
| HR | Timeoff | user_id | The employee that this time off request pertains to |
| HR | Timeoff | approver_user_id | The employee that approved this time off request |
| KMS | Space | user_id | The creator of this space |
| KMS | Page | user_id | The creator of this oage |
| Messaging | Message | author_member.user_id | |
| Messaging | Message | destination_members.user_id | |
| Messaging | Message | hidden_members.user_id | |
| Messaging | Message | mentioned_members.user_id | |
| Storage | File | user_id | The owner of this file/folder |
| Tasks | Project | user_ids | The users that belong to this project |
| Tasks | Task | assigned_user_id | |
| Tasks | Task | creator_user_id | |
| Tasks | Task | follower_user_ids | |
| Ticketing | Note | user_id | The user who created this note |
| Ticketing | Ticket | user_id | The user who created this ticket |
undefined Here are several practical use cases that leverage our unified HR API for non-HR use-cases:
Streamlined Onboarding: Automate your customers' onboarding process by syncing employee data across HR, task management, and training platforms. Ensure that new hires are promptly added to all necessary systems and have access to the right resources from day one.
Assigning Leads and Deals: Assign newly created leads and/or deals to a specific sales-rep using their user ID
Notify Hiring Managers: When adding a new candidate and their job application, notify the hiring manager by retrieving their information and emailing them
By integrating employee data across multiple SaaS platforms, organizations can improve operational efficiency, enhance data accuracy, and provide a better employee experience.