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
This node integrates with the Magnet Customer API to perform various operations on different resources, including workspaces. Specifically, for the Workspace resource and the Search operation, it allows users to search for workspaces based on a search term and apply filters such as whether emails, phones, or interactions are empty. This is useful in scenarios where you want to find specific workspaces matching certain criteria, for example, to analyze active workspaces, identify those missing contact information, or retrieve paginated results sorted by creation date or other fields.
Practical examples:
- Searching for workspaces containing a keyword in their name or description.
- Filtering workspaces that have no associated email addresses or phone numbers.
- Sorting search results by creation date in descending order to get the most recent workspaces first.
- Paginating through large sets of workspace data efficiently.
Properties
| Name | Meaning |
|---|---|
| Authentication | Method of authentication: "API Token" or "OAuth2". |
| Page | The page number of results to return (pagination). Default is 1. |
| Limit | Maximum number of results to return per request. Minimum 1, default 15. |
| Search Term | The text string to search for within workspaces. |
| Filters | Collection of filters to narrow down results: - Emails Empty: filter workspaces with empty emails. - Phones Empty: filter workspaces with empty phones. - Interactions Empty: filter workspaces with empty interactions. |
| Sort | Collection of sorting options: - Sort By: field to sort by (e.g., email, createdAt, name). - Sort Type: direction of sorting, either Ascending or Descending. |
Note: There are several hidden properties related to "Life Cycle" and "Source" which are preset and not user-configurable in this context.
Output
The node outputs an array of JSON objects representing the workspaces matching the search criteria. Each object contains the workspace data fields returned by the Magnet Customer API. The exact structure depends on the API response but typically includes identifiers, names, contact details, interaction counts, timestamps, and other metadata relevant to each workspace.
No binary data output is indicated for this operation.
Dependencies
- Requires access to the Magnet Customer API.
- Requires configuration of credentials in n8n for either API Token or OAuth2 authentication.
- The node uses internal helper functions to make HTTP requests to the API endpoints corresponding to the workspace resource.
Troubleshooting
Common issues:
- Authentication failures due to incorrect or expired API tokens or OAuth2 credentials.
- Pagination parameters out of range or invalid limit values causing empty or partial results.
- Using unsupported or misspelled filter or sort fields may result in errors or unexpected results.
Error messages:
- Errors from the API will be caught and returned as error messages in the output if "Continue On Fail" is enabled.
- Typical error messages include authentication errors ("Unauthorized"), invalid parameter errors, or network connectivity issues.
Resolutions:
- Verify and update API credentials.
- Ensure pagination and limit values are valid positive integers.
- Double-check filter and sort option values against the API documentation.
- Enable "Continue On Fail" to handle errors gracefully during batch processing.
Links and References
- Magnet Customer API Documentation (Assumed URL, replace with actual if known)
- n8n Documentation on Creating Custom Nodes
- n8n Credential Management Guide for API Tokens and OAuth2
If you need further details about other operations or resources, feel free to ask!