Actions101
- Attendance Actions
- Client Actions
- Department Actions
- Designation Actions
- Employee Actions
- Holiday Actions
- KPI Actions
- KPI Category Actions
- KPI Data Actions
- Lead Actions
- Leave Actions
- OKR Key Result Actions
- OKR Objective Actions
- Performance Cycle Actions
- Project Actions
- Project Category Actions
- Task Actions
- Task Category Actions
- Ticket Actions
- Ticket Agent Actions
- Ticket Channel Actions
- Ticket Type Actions
Overview
The node provides integration with the Flowyteam API to manage employee records. Specifically, the "Employee" resource with the "Get Many" operation allows users to retrieve multiple employee records from the system. This operation supports pagination, filtering, sorting, and the option to return either simplified or raw data.
This node is beneficial in scenarios where you need to:
- Fetch a list of employees for reporting or analytics.
- Synchronize employee data with other systems.
- Display employee directories or organizational charts.
- Filter employees by status, department, or designation dynamically.
For example, you could use this node to get all active employees in a specific department sorted by name ascending, or fetch a limited number of employees matching a search term.
Properties
| Name | Meaning |
|---|---|
| Return All | Whether to return all employee records or limit the number of results. |
| Limit | Maximum number of employee records to return (used if Return All is false). |
| Page | Page number for paginated results (used if Return All is false). |
| Simplify | Whether to return simplified employee data or the full raw API response. |
| Sort Direction | Direction to sort the results: Ascending or Descending. |
| Sort Field | Field to sort by: ID or Name. |
| Additional Fields | Collection of optional filters: |
| - Search | Search term to filter employees by name, email, or other fields. |
| - Status | Filter employees by status: All, Active, or Inactive. |
| - Department ID | Filter employees by a specific department ID. |
| - Designation ID | Filter employees by a specific designation ID. |
Output
The output is an array of JSON objects representing employee records retrieved from the Flowyteam API.
- If Simplify is enabled, the output contains a streamlined version of employee data with key fields for easier consumption.
- If Simplify is disabled, the output includes the full raw API response for each employee, which may contain additional metadata and nested information.
No binary data output is produced by this operation.
Dependencies
- Requires an API key credential for authenticating with the Flowyteam API.
- The node depends on the Flowyteam service being accessible and the API credentials having sufficient permissions to read employee data.
- No additional environment variables are required beyond the configured API authentication.
Troubleshooting
Common Issues:
- Pagination parameters (Page and Limit) must be positive integers; invalid values may cause errors or empty results.
- Filtering by Department ID or Designation ID requires valid existing IDs; otherwise, no employees will be returned.
- Network or authentication failures will prevent data retrieval.
Error Messages:
- Errors related to unsupported operations or resources indicate misconfiguration of the node parameters.
- Authentication errors suggest invalid or missing API credentials.
- API rate limits or server errors from Flowyteam may result in temporary failures; retrying later is recommended.
Links and References
- Flowyteam API Documentation (general reference for API endpoints and data structures)
- n8n documentation on Creating Custom Nodes