ServiceM8 icon

ServiceM8

ServiceM8 Node
Join our community

Actions11

Overview

This node integrates with the ServiceM8 platform to manage various resources such as Jobs, Clients, Emails, and SMS messages. Specifically, for the Job resource with the Get Many operation, it retrieves multiple job records from ServiceM8 based on user-defined filters.

Typical use cases include:

  • Fetching a list of jobs that meet certain criteria (e.g., jobs created after a specific date or jobs assigned to a particular staff member).
  • Automating workflows that require batch processing or reporting on jobs.
  • Integrating job data into other systems or dashboards by retrieving filtered job lists.

For example, you might use this node to get all jobs where the status is "In Progress" or all jobs scheduled within a certain date range.

Properties

Name Meaning
Filters A collection of filter conditions to narrow down the jobs retrieved. Each filter includes:
- Field Name or ID: The job field to filter by (selectable from available job fields).
- Operator: The comparison operator to apply (Equal To, Not Equal, Greater Than, Less Than).
- Value: The value to compare the field against.

Filters can be combined with multiple conditions to refine the query.

Output

The node outputs an array of JSON objects representing the jobs retrieved from ServiceM8. Each object corresponds to a single job record and contains all relevant job data fields as returned by the ServiceM8 API.

There is no binary data output for this operation.

Example output structure (simplified):

[
  {
    "id": "job-uuid",
    "client": "client-uuid",
    "status": "In Progress",
    "scheduled_date": "2024-06-01T10:00:00Z",
    "description": "Fix leaking pipe",
    ...
  },
  ...
]

Dependencies

  • Requires an API key credential for authenticating with the ServiceM8 API.
  • The node uses the ServiceM8 REST API endpoints to fetch job data.
  • No additional external dependencies beyond the configured API credentials.

Troubleshooting

  • No jobs returned:
    Ensure that your filter criteria are correct and match existing job data. Incorrect field names or values may result in empty results.

  • Invalid filter field or operator:
    Use the provided dropdown options for fields and operators to avoid invalid queries.

  • API authentication errors:
    Verify that the API key credential is correctly configured and has sufficient permissions.

  • Rate limiting or network errors:
    If the node fails due to network issues or API rate limits, consider adding retry logic or reducing request frequency.

  • Error message "No fields to update were added" (not applicable here but seen in other operations):
    This indicates missing required input fields when updating; ensure all mandatory fields are provided.

Links and References

Discussion