ServiceM8 icon

ServiceM8

ServiceM8 Node

Actions11

Overview

The node integrates with the ServiceM8 platform, allowing users to perform various operations on different resources such as Clients, Jobs, Emails, and SMS. Specifically, for the Client resource with the Get Many operation, the node fetches multiple client records from ServiceM8 based on user-defined filters.

This is useful in scenarios where you want to retrieve a list of clients matching certain criteria, for example:

  • Fetching all clients located in a specific city.
  • Retrieving clients created after a certain date.
  • Getting clients whose status equals or does not equal a particular value.

Such functionality helps automate workflows that require bulk data retrieval for further processing, reporting, or integration with other systems.

Properties

Name Meaning
Filters A collection of filter conditions to narrow down the clients retrieved. Each filter includes:
- Field Name or ID: The client field to filter by (loaded dynamically).
- Operator: Comparison operator (Equal To, Not Equal, Greater Than, Less Than).
- Value: The value to compare against. Multiple filters can be combined.

Output

The node outputs an array of JSON objects representing the clients retrieved from ServiceM8. Each object corresponds to a client record containing fields as returned by the ServiceM8 API.

  • The output is accessible via the json property of each item.
  • No binary data output is produced by this operation.

Example output snippet (simplified):

[
  {
    "id": "client-uuid-123",
    "name": "John Doe",
    "email": "john.doe@example.com",
    "phone": "1234567890",
    ...
  },
  {
    "id": "client-uuid-456",
    "name": "Jane Smith",
    "email": "jane.smith@example.com",
    "phone": "0987654321",
    ...
  }
]

Dependencies

  • Requires an API key credential for authenticating with the ServiceM8 API.
  • The node uses the ServiceM8 REST API endpoints to fetch data.
  • No additional external dependencies beyond standard n8n environment and the provided credentials.

Troubleshooting

  • No results returned: Ensure that the filter fields and values are correct and correspond to existing client data in ServiceM8. Also, verify that the API credentials have sufficient permissions.
  • Invalid filter field or operator: The filter fields are dynamically loaded; if a field is not available, it might not exist for the Client resource or the API schema may have changed.
  • API request failures: Common errors include authentication issues (invalid API key), rate limiting, or network problems. Check the credentials and network connectivity.
  • Empty filters: If no filters are specified, the node will return all clients, which could be a large dataset and impact performance.

Links and References

Discussion