Actions104
- Custom Field Actions
- Custom Field Block Actions
- Custom Field Type Actions
- Customer Actions
- Deal Actions
- Lead Actions
- Meeting Actions
- Meeting Room Actions
- Meeting Type Actions
- Organization Actions
- Pipeline Actions
- Prospect Actions
- Staff Actions
- Task Actions
- Ticket Actions
- Treatment Actions
- Treatment Type Actions
- Workspace Actions
Staff → Search
AI-generatedOverview
This node performs a search operation on the 'Staff' resource using the Magnet Customer API. It allows users to search for staff members based on a search term, with options to paginate results by specifying the page number and limit of results per page. This is useful for scenarios where you need to find specific staff members in a large database, such as in customer relationship management or internal staff directories.
Use Case Examples
- Searching for staff members by name or keyword to quickly find contact details or roles.
- Retrieving a paginated list of staff members matching certain criteria for reporting or integration purposes.
Properties
| Name | Meaning |
|---|---|
| Authentication | Selects the authentication method to use for the API request (API Token or OAuth2). |
| Page | The page number of the search results to retrieve, used for pagination. |
| Limit | The maximum number of search results to return per page, with a minimum value of 15. |
| Search Term | The term or keyword to search for within the staff records. This is a required field for the search operation. |
Output
JSON
_id- Unique identifier of the staff member.fullname- Full name of the staff member.email- Email address of the staff member.active- Indicates if the staff member is currently active.role- Role or position of the staff member within the organization.otherProperties- Additional properties returned by the API related to the staff member.
Dependencies
- Magnet Customer API
Troubleshooting
- Ensure the authentication credentials (API Token or OAuth2) are correctly configured and valid to avoid authentication errors.
- Verify that the 'Search Term' property is provided and not empty, as it is required for the search operation.
- Check API rate limits and pagination parameters ('Page' and 'Limit') to avoid incomplete or missing results.
- If custom fields are used, enabling 'Resolve Custom Fields' may help in getting more readable data instead of IDs.
Links
- Magnet Customer API - Staff Resource - Official API documentation for the Staff resource in Magnet Customer API, useful for understanding available fields and search capabilities.