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 client information. Specifically, the "Client" resource with the "Get Many" operation allows users to retrieve multiple client records from Flowyteam. This operation supports filtering, sorting, and pagination, enabling efficient querying of client data.
Common scenarios where this node is beneficial include:
- Fetching a list of clients for reporting or analysis.
- Synchronizing client data between Flowyteam and other systems.
- Building dashboards that display client information filtered by status, creation date, or search terms.
For example, a user might want to retrieve all active clients created in the last month, sorted by name ascending, to generate a monthly client report.
Properties
| Name | Meaning |
|---|---|
| Simplify | Whether to return simplified response data (true) or the raw API response (false). |
| Return All | Whether to return all results (true) or limit the number of results returned (false). |
| Limit | Maximum number of results to return when "Return All" is false. Minimum value is 1. |
| Page | Page number for pagination when "Return All" is false. Minimum value is 1. |
| Additional Fields | Collection of optional filters: |
| - Client ID | Filter results by a specific client ID. |
| - End Date | Filter clients created up to this date/time. |
| - Search | Search clients by name, company name, or email using a text term. |
| - Start Date | Filter clients created from this date/time. |
| - Status | Filter clients by status; options are "All", "Active", or "Inactive". |
| Sort Direction | Direction to sort the results; options are "Ascending" or "Descending". |
| Sort Field | Field to sort by; options are "ID" or "Name". |
Output
The output is an array of JSON objects representing client records retrieved from Flowyteam. The structure depends on whether the "Simplify" property is true or false:
- If Simplify is true, the output contains a simplified version of client data with key fields for easier consumption.
- If Simplify is false, the output includes the full raw API response for each client, which may contain additional metadata and nested structures.
No binary data is produced by this operation.
Dependencies
- Requires an API key credential for authenticating with the Flowyteam API.
- The node must be configured with valid Flowyteam API credentials in n8n.
- Network access to the Flowyteam API endpoint is necessary.
Troubleshooting
Common issues:
- Invalid or missing API credentials will cause authentication errors.
- Using invalid filter values (e.g., incorrect date formats) may result in API errors.
- Requesting too many records without pagination may lead to timeouts or rate limiting.
Error messages:
- Authentication failures typically indicate invalid API keys; verify and update credentials.
- Validation errors from the API often specify which parameter is incorrect; adjust input accordingly.
- Rate limit exceeded errors suggest adding delays or reducing request frequency.
Links and References
- Flowyteam API Documentation (general reference for API endpoints and parameters)
- n8n documentation on creating custom nodes