Actions68
- Custom Field Actions
- Custom Field Block Actions
- Custom Field Type Actions
- Customer Actions
- Deal Actions
- Lead Actions
- Organization Actions
- Pipeline Actions
- Prospect Actions
- Staff Actions
- Task Actions
- Workspace Actions
Overview
The "Staff Search" operation in this node allows users to search for staff members within the Magnet Customer system using a specified search term. This is useful for scenarios where you want to find specific staff records based on partial or full matches of names or other searchable attributes.
Practical examples include:
- Searching for staff members by name or email to assign tasks or deals.
- Filtering staff lists dynamically based on user input.
- Integrating staff lookup into automated workflows for notifications or reporting.
Properties
| Name | Meaning |
|---|---|
| Authentication | Method of authentication to use: either "API Token" or "OAuth2". |
| Page | The page number of results to retrieve (pagination). |
| Limit | Maximum number of staff results to return. Minimum value is 1. |
| Search Term | The string term used to search staff records. Required field. |
Note: There are several hidden properties related to "Life Cycle" and "Source" which are preset internally and not exposed for user input in this operation.
Output
The output is a JSON array where each item represents a staff member matching the search criteria. Each staff object contains fields as returned by the Magnet Customer API, typically including identifiers, full names, active status, and other staff-related metadata.
No binary data output is produced by this operation.
Dependencies
- Requires access to the Magnet Customer API.
- Requires an API key credential or OAuth2 authentication configured in n8n.
- The node uses internal helper functions to make authenticated HTTP requests to the Magnet Customer API endpoints.
Troubleshooting
- Empty Results: If no staff members are returned, verify that the search term is correct and that the account has staff records matching the query.
- Authentication Errors: Ensure that the API token or OAuth2 credentials are valid and have sufficient permissions.
- Pagination Issues: If expecting more results, adjust the "Page" and "Limit" parameters accordingly.
- API Rate Limits: Be aware of any rate limits imposed by the Magnet Customer API which might cause request failures.
Common error messages will typically relate to invalid credentials, missing required parameters (like the search term), or network connectivity issues. Resolving these involves checking credentials, ensuring all required inputs are provided, and verifying network access.
Links and References
- Magnet Customer API Documentation (example placeholder link)
- n8n documentation on creating custom nodes
- OAuth2 and API token authentication best practices in n8n
This summary is based solely on static analysis of the provided source code and property definitions.