ServiceM8 icon

ServiceM8

ServiceM8 Node

Overview

The node integrates with the ServiceM8 platform, providing various operations on different resources such as clients, jobs, emails, SMS, and search functionalities. Specifically, for the Search resource with the Global Search operation, it performs a global search query across the ServiceM8 data.

This operation is useful when you want to quickly find records matching a search term without specifying a particular object type. For example, you might use it to locate clients, jobs, or other entities containing a keyword or phrase.

Practical examples:

  • Searching for all records related to "plumbing" across multiple ServiceM8 objects.
  • Quickly retrieving a list of items matching a customer name or job description.

Properties

Name Meaning
Fields Collection of search options:
- Search Query (q): The text string to search for.
- Limit: Maximum number of results to return (minimum 1, default 50).

Output

The output is a JSON array where each element corresponds to a search result item returned by the ServiceM8 API. Each item contains the data fields as provided by the API response for the global search.

No binary data output is produced by this operation.

Dependencies

  • Requires an API key credential for authenticating with the ServiceM8 API.
  • The node makes HTTP requests to the ServiceM8 REST API endpoints.
  • No additional external dependencies beyond the configured API credentials.

Troubleshooting

  • No search query was provided: The node throws an error if the search query (q) field is empty or missing. Ensure that you provide a valid non-empty search string.
  • API request failures: Errors from the ServiceM8 API (e.g., authentication errors, rate limits) will be surfaced. Verify your API credentials and network connectivity.
  • Empty results: If no matches are found, the output will be an empty array. Confirm the search query is correct and expected to yield results.

Links and References

Discussion