Employees
A person employed by a company, with current hire and separation dates.
- API name:
employees - Domain: Employment
- Modules: Human resources, My workspace, Directory
Fields
The API name is what the API, MCP and the CLI use.
| Name | API name | Type | Required | Description |
|---|---|---|---|---|
| ID | id | Record ID | Yes | |
| First name | firstName | Text | Yes | |
| Middle name | middleName | Text | ||
| Paternal last name | paternalLastName | Text | Yes | |
| Maternal last name | maternalLastName | Text | ||
| Full name | fullName | Text | Yes | |
| User | userId | User | ||
| Address | address | Address | ||
| Department | employeedepartmentId | Reference | ||
| Employee number | employeeNumber | Text | ||
| PIN | pin | PIN | 6-digit PIN to identify in portals. Leave empty to keep it unchanged. | |
| Date of birth | dateBirth | Date | ||
| Nationality | nationality | Constant | ||
| Gender | gender | Constant | ||
| Emails | emails | Email | Emails | ||
| Phones | phones | Phone | Phones | ||
| Emergency contacts | emergencyContacts | JSON | Each entry has a name, a phone and a relationship. | |
| Links | links | Link | Links | ||
| Hire date | dateHire | Date | Yes | |
| Separation date | dateSeparation | Date | ||
| Image | image | Image | ||
| Tags | tagIds | Tags | ||
| Data | data | Data | ||
| Created by | createdBy | User | ||
| Created at | createdAt | Date and Time | Yes | |
| Updated by | updatedBy | User | ||
| Updated at | updatedAt | Date and Time | Yes | |
| Ended by | endedBy | User | ||
| Ended at | endedAt | Date and Time | ||
| Blocked by | blockedBy | User | ||
| Blocked at | blockedAt | Date and Time | ||
| Archived by | archivedBy | User | ||
| Archived at | archivedAt | Date and Time |
Relations
Owned records (solid line) are deleted with their owner. Grouped records (dashed line) can exist alone.
| Field | Points to | Kind |
|---|---|---|
User userId | Users | reference |
Department employeedepartmentId | Employee departments | reference |
Tags tagIds | Tags | reference |
Actions
What you can do with a record. Every action also sends the webhook event employees.<action>. Reads (find, get, count) work on every table.
| Name | API name | Description | Where |
|---|---|---|---|
| Create | create | Add an new employee. | App · WebMCP · API · MCP · CLI |
| Edit | update | Save changes to this employee. | App · WebMCP · API · MCP · CLI |
| Separate employee | end | Set employment end date and close open assignments, shifts, and salary. | App · WebMCP · API · MCP · CLI |
| Block | block | Stop edits and deletion of this employee. It stays visible and can still appear on existing documents. Unblock to edit again. | App · WebMCP · API · MCP · CLI |
| Unblock | unblock | Allow edits and deletion of this employee again. | App · WebMCP · API · MCP · CLI |
| Archive | archive | Retire this employee from daily use. It leaves active lists and pickers, and most actions stop. Unarchive to restore it. | App · WebMCP · API · MCP · CLI |
| Restore | unarchive | Return this employee to active lists and actions. | App · WebMCP · API · MCP · CLI |
| Delete | delete | Delete this employee and the data that belongs with it. This cannot be undone. | App · WebMCP · API · MCP · CLI |
States
How a record moves from state to state. Archive and block can happen in any state.