Productivity · CONNECTION

ServiceM8 + NodeHub

Jobs, clients, scheduling, materials, forms, inbox and email or SMS sends in ServiceM8.

Explore 208 workflow actions for ServiceM8, including account permissions and operation limits.

94 read actions114 write actions

WORKFLOW ACTIONS

What you can configure.

Choose an action in the workflow builder, connect an account, and map its inputs. These actions are available in the catalog; your account access and a successful test determine whether they work for your setup.

Add note to message

Write

Adds a note to an inbox message

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

A repeated request may repeat the external action. Review the previous result before retrying a write.

Archive or unarchive message

Write

Archives or unarchives an inbox message

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

A repeated request may repeat the external action. Review the previous result before retrying a write.

Attach message to existing job

Write

Attaches an inbox message to an existing job

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

A repeated request may repeat the external action. Review the previous result before retrying a write.

Convert message to job

Write

Converts an inbox message into a new job, optionally using a job template

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

A repeated request may repeat the external action. Review the previous result before retrying a write.

Create a job from a template

Write

Creates a new job by cloning an existing job template.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

A repeated request may repeat the external action. Review the previous result before retrying a write.

Create a new Allocation Window

Write

OAuth Scope This endpoint requires the following OAuth scope manageschedule.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

A repeated request may repeat the external action. Review the previous result before retrying a write.

Create a new Asset Type

Write

OAuth Scope This endpoint requires the following OAuth scope manageassets.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

A repeated request may repeat the external action. Review the previous result before retrying a write.

Create a new Asset Type Field

Write

OAuth Scope This endpoint requires the following OAuth scope manageassets.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

A repeated request may repeat the external action. Review the previous result before retrying a write.

Create a new Attachment

Write

OAuth Scope This endpoint requires the following OAuth scope manageattachments.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

A repeated request may repeat the external action. Review the previous result before retrying a write.

Create a new Availability

Write

OAuth Scope This endpoint requires the following OAuth scope manageschedule.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

A repeated request may repeat the external action. Review the previous result before retrying a write.

Create a new Badge

Write

OAuth Scope This endpoint requires the following OAuth scope managebadges.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

A repeated request may repeat the external action. Review the previous result before retrying a write.

Create a new Bundle

Write

OAuth Scope This endpoint requires the following OAuth scope manageinventory.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

A repeated request may repeat the external action. Review the previous result before retrying a write.

Create a new Category

Write

OAuth Scope This endpoint requires the following OAuth scope managejobcategories.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

A repeated request may repeat the external action. Review the previous result before retrying a write.

Create a new Client

Write

OAuth Scope This endpoint requires the following OAuth scope managecustomers.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

A repeated request may repeat the external action. Review the previous result before retrying a write.

Create a new Company Contact

Write

OAuth Scope This endpoint requires the following OAuth scope managecustomercontacts.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

A repeated request may repeat the external action. Review the previous result before retrying a write.

Create a new Document Template

Write

OAuth Scope This endpoint requires the following OAuth scope managetemplates.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

A repeated request may repeat the external action. Review the previous result before retrying a write.

Create a new Email Template

Write

OAuth Scope This endpoint requires the following OAuth scope managetemplates.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

A repeated request may repeat the external action. Review the previous result before retrying a write.

Create a new Feedback

Write

OAuth Scope This endpoint requires the following OAuth scope managefeedback.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

A repeated request may repeat the external action. Review the previous result before retrying a write.

Create a new Form

Write

OAuth Scope This endpoint requires the following OAuth scope manageforms.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

A repeated request may repeat the external action. Review the previous result before retrying a write.

Create a new Form Field

Write

OAuth Scope This endpoint requires the following OAuth scope manageforms.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

A repeated request may repeat the external action. Review the previous result before retrying a write.

Create a new Form Response

Write

OAuth Scope This endpoint requires the following OAuth scope manageforms.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

A repeated request may repeat the external action. Review the previous result before retrying a write.

Create a new inbox message

Write

Creates a new inbox message that will appear in the inbox

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

A repeated request may repeat the external action. Review the previous result before retrying a write.

Create a new Job

Write

OAuth Scope This endpoint requires the following OAuth scope createjobs.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

A repeated request may repeat the external action. Review the previous result before retrying a write.

Create a new Job Activity

Write

OAuth Scope This endpoint requires the following OAuth scope manageschedule.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

A repeated request may repeat the external action. Review the previous result before retrying a write.

Create a new Job Allocation

Write

OAuth Scope This endpoint requires the following OAuth scope manageschedule.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

A repeated request may repeat the external action. Review the previous result before retrying a write.

Create a new Job Checklist

Write

OAuth Scope This endpoint requires the following OAuth scope managejobchecklists.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

A repeated request may repeat the external action. Review the previous result before retrying a write.

Create a new Job Contact

Write

OAuth Scope This endpoint requires the following OAuth scope managejobcontacts.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

A repeated request may repeat the external action. Review the previous result before retrying a write.

Create a new Job Material

Write

OAuth Scope This endpoint requires the following OAuth scope managejobmaterials.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

A repeated request may repeat the external action. Review the previous result before retrying a write.

Create a new Job Material Bundle

Write

OAuth Scope This endpoint requires the following OAuth scope managejobmaterials.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

A repeated request may repeat the external action. Review the previous result before retrying a write.

Create a new Job Queue

Write

OAuth Scope This endpoint requires the following OAuth scope managejobqueues.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

A repeated request may repeat the external action. Review the previous result before retrying a write.

Create a new Knowledge Article

Write

OAuth Scope This endpoint requires the following OAuth scope manageknowledge.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

A repeated request may repeat the external action. Review the previous result before retrying a write.

Create a new Location

Write

OAuth Scope This endpoint requires the following OAuth scope managelocations.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

A repeated request may repeat the external action. Review the previous result before retrying a write.

Create a new Material

Write

OAuth Scope This endpoint requires the following OAuth scope manageinventory.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

A repeated request may repeat the external action. Review the previous result before retrying a write.

Create a new Note

Write

OAuth Scope This endpoint requires the following OAuth scope publishjobnotes.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

A repeated request may repeat the external action. Review the previous result before retrying a write.

Create a new SMS Template

Write

OAuth Scope This endpoint requires the following OAuth scope managetemplates.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

A repeated request may repeat the external action. Review the previous result before retrying a write.

Create a new Staff Message

Write

OAuth Scope This endpoint requires the following OAuth scope publishmessages.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

A repeated request may repeat the external action. Review the previous result before retrying a write.

Create a new Supplier

Write

OAuth Scope This endpoint requires the following OAuth scope managesuppliers.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

A repeated request may repeat the external action. Review the previous result before retrying a write.

Create a new Task

Write

OAuth Scope This endpoint requires the following OAuth scope managetasks.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

A repeated request may repeat the external action. Review the previous result before retrying a write.

Create a new Tax Rate

Write

OAuth Scope This endpoint requires the following OAuth scope managetaxrates.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

A repeated request may repeat the external action. Review the previous result before retrying a write.

Create or update a ServiceTemplate

Write

Creates or sparsely updates an editable Service record.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

A repeated request may repeat the external action. Review the previous result before retrying a write.

Delete a Badge

Write

In ServiceM8, deleting a record sets its active field to 0.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

A repeated request may repeat the external action. Review the previous result before retrying a write.

Delete a Bundle

Write

In ServiceM8, deleting a record sets its active field to 0.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

A repeated request may repeat the external action. Review the previous result before retrying a write.

Delete a Category

Write

In ServiceM8, deleting a record sets its active field to 0.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

A repeated request may repeat the external action. Review the previous result before retrying a write.

Delete a Client

Write

In ServiceM8, deleting a record sets its active field to 0.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

A repeated request may repeat the external action. Review the previous result before retrying a write.

Delete a Company Contact

Write

In ServiceM8, deleting a record sets its active field to 0.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

A repeated request may repeat the external action. Review the previous result before retrying a write.

Delete a Document Template

Write

In ServiceM8, deleting a record sets its active field to 0.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

A repeated request may repeat the external action. Review the previous result before retrying a write.

Delete a Feedback

Write

In ServiceM8, deleting a record sets its active field to 0.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

A repeated request may repeat the external action. Review the previous result before retrying a write.

Delete a Form

Write

In ServiceM8, deleting a record sets its active field to 0.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

A repeated request may repeat the external action. Review the previous result before retrying a write.

Delete a Form Field

Write

In ServiceM8, deleting a record sets its active field to 0.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

A repeated request may repeat the external action. Review the previous result before retrying a write.

Delete a Form Response

Write

In ServiceM8, deleting a record sets its active field to 0.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

A repeated request may repeat the external action. Review the previous result before retrying a write.

Delete a Job

Write

In ServiceM8, deleting a record sets its active field to 0.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

A repeated request may repeat the external action. Review the previous result before retrying a write.

Delete a Job Activity

Write

In ServiceM8, deleting a record sets its active field to 0.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

A repeated request may repeat the external action. Review the previous result before retrying a write.

Delete a Job Allocation

Write

In ServiceM8, deleting a record sets its active field to 0.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

A repeated request may repeat the external action. Review the previous result before retrying a write.

Delete a Job Checklist

Write

In ServiceM8, deleting a record sets its active field to 0.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

A repeated request may repeat the external action. Review the previous result before retrying a write.

Delete a Job Contact

Write

In ServiceM8, deleting a record sets its active field to 0.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

A repeated request may repeat the external action. Review the previous result before retrying a write.

Delete a Job Material

Write

In ServiceM8, deleting a record sets its active field to 0.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

A repeated request may repeat the external action. Review the previous result before retrying a write.

Delete a Job Material Bundle

Write

In ServiceM8, deleting a record sets its active field to 0.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

A repeated request may repeat the external action. Review the previous result before retrying a write.

Delete a Job Queue

Write

In ServiceM8, deleting a record sets its active field to 0.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

A repeated request may repeat the external action. Review the previous result before retrying a write.

Delete a Knowledge Article

Write

In ServiceM8, deleting a record sets its active field to 0.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

A repeated request may repeat the external action. Review the previous result before retrying a write.

Delete a Location

Write

In ServiceM8, deleting a record sets its active field to 0.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

A repeated request may repeat the external action. Review the previous result before retrying a write.

Delete a Material

Write

In ServiceM8, deleting a record sets its active field to 0.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

A repeated request may repeat the external action. Review the previous result before retrying a write.

Delete a Note

Write

In ServiceM8, deleting a record sets its active field to 0.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

A repeated request may repeat the external action. Review the previous result before retrying a write.

Delete a SMS Template

Write

In ServiceM8, deleting a record sets its active field to 0.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

A repeated request may repeat the external action. Review the previous result before retrying a write.

Delete a Staff Message

Write

In ServiceM8, deleting a record sets its active field to 0.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

A repeated request may repeat the external action. Review the previous result before retrying a write.

Delete a Supplier

Write

In ServiceM8, deleting a record sets its active field to 0.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

A repeated request may repeat the external action. Review the previous result before retrying a write.

Delete a Task

Write

In ServiceM8, deleting a record sets its active field to 0.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

A repeated request may repeat the external action. Review the previous result before retrying a write.

Delete a Tax Rate

Write

In ServiceM8, deleting a record sets its active field to 0.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

A repeated request may repeat the external action. Review the previous result before retrying a write.

Delete an Allocation Window

Write

In ServiceM8, deleting a record sets its active field to 0.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

A repeated request may repeat the external action. Review the previous result before retrying a write.

Delete an Asset

Write

In ServiceM8, deleting a record sets its active field to 0.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

A repeated request may repeat the external action. Review the previous result before retrying a write.

Delete an Asset Type

Write

In ServiceM8, deleting a record sets its active field to 0.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

A repeated request may repeat the external action. Review the previous result before retrying a write.

Delete an Asset Type Field

Write

In ServiceM8, deleting a record sets its active field to 0.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

A repeated request may repeat the external action. Review the previous result before retrying a write.

Delete an Attachment

Write

In ServiceM8, deleting a record sets its active field to 0.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

A repeated request may repeat the external action. Review the previous result before retrying a write.

Delete an Availability

Write

In ServiceM8, deleting a record sets its active field to 0.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

A repeated request may repeat the external action. Review the previous result before retrying a write.

Delete an Email Template

Write

In ServiceM8, deleting a record sets its active field to 0.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

A repeated request may repeat the external action. Review the previous result before retrying a write.

Download an Attachment file

Read

Retrieve the binary file associated with an Attachment.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

Get a ServiceTemplate

Read

Retrieves one editable or published Service record by UUID.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

Get inbox message details

Read

Retrieves detailed information about a specific inbox message including attachments and conversation history

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

Get one job email record

Read

Returns a single job email record by UUID.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

Get one job SMS record

Read

Returns a single merged job SMS record by UUID.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

List all Allocation Windows

Read

Filtering This endpoint supports result filtering using the $filter query parameter.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

List all Asset Type Fields

Read

Filtering This endpoint supports result filtering using the $filter query parameter.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

List all Asset Types

Read

Filtering This endpoint supports result filtering using the $filter query parameter.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

List all Assets

Read

Filtering This endpoint supports result filtering using the $filter query parameter.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

List all Attachments

Read

Filtering This endpoint supports result filtering using the $filter query parameter.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

List all Availabilities

Read

Filtering This endpoint supports result filtering using the $filter query parameter.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

List all Badges

Read

Filtering This endpoint supports result filtering using the $filter query parameter.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

List all Bundles

Read

Filtering This endpoint supports result filtering using the $filter query parameter.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

List all Categories

Read

Filtering This endpoint supports result filtering using the $filter query parameter.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

List all Clients

Read

Filtering This endpoint supports result filtering using the $filter query parameter.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

List all Company Contacts

Read

Filtering This endpoint supports result filtering using the $filter query parameter.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

List all Document Templates

Read

Filtering This endpoint supports result filtering using the $filter query parameter.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

List all Email Templates

Read

Filtering This endpoint supports result filtering using the $filter query parameter.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

List all Feedback

Read

Filtering This endpoint supports result filtering using the $filter query parameter.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

List all Form Fields

Read

Filtering This endpoint supports result filtering using the $filter query parameter.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

List all Form Responses

Read

Filtering This endpoint supports result filtering using the $filter query parameter.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

List all Forms

Read

Filtering This endpoint supports result filtering using the $filter query parameter.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

List all Job Activities

Read

Filtering This endpoint supports result filtering using the $filter query parameter.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

List all Job Activities

Read

Filtering This endpoint supports result filtering using the $filter query parameter.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

List all Job Allocations

Read

Filtering This endpoint supports result filtering using the $filter query parameter.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

List all Job Checklists

Read

Filtering This endpoint supports result filtering using the $filter query parameter.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

List all Job Contacts

Read

Filtering This endpoint supports result filtering using the $filter query parameter.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

List all Job Material Bundles

Read

Filtering This endpoint supports result filtering using the $filter query parameter.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

List all Job Materials

Read

Filtering This endpoint supports result filtering using the $filter query parameter.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

List all Job Payments

Read

Filtering This endpoint supports result filtering using the $filter query parameter.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

List all Job Queues

Read

Filtering This endpoint supports result filtering using the $filter query parameter.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

List all Job Templates

Read

Filtering This endpoint supports result filtering using the $filter query parameter.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

List all Jobs

Read

Filtering This endpoint supports result filtering using the $filter query parameter.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

List all Knowledge Articles

Read

Filtering This endpoint supports result filtering using the $filter query parameter.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

List all Locations

Read

Filtering This endpoint supports result filtering using the $filter query parameter.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

List all Materials

Read

Filtering This endpoint supports result filtering using the $filter query parameter.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

List all Notes

Read

Filtering This endpoint supports result filtering using the $filter query parameter.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

List all Security Roles

Read

Filtering This endpoint supports result filtering using the $filter query parameter.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

List all SMS Templates

Read

Filtering This endpoint supports result filtering using the $filter query parameter.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

List all Staff Members

Read

Filtering This endpoint supports result filtering using the $filter query parameter.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

List all Staff Messages

Read

Filtering This endpoint supports result filtering using the $filter query parameter.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

List all Staff Time Events

Read

Staff clock-on, clock-off and lunch-break events, separate from job check-in activity.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

List all Suppliers

Read

Filtering This endpoint supports result filtering using the $filter query parameter.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

List all Tasks

Read

Filtering This endpoint supports result filtering using the $filter query parameter.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

List all Tax Rates

Read

Filtering This endpoint supports result filtering using the $filter query parameter.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

List all Vendors

Read

Vendor account information Filtering This endpoint supports result filtering using the $filter query parameter.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

List inbox messages

Read

Retrieves a paginated list of inbox messages with optional filtering

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

List job email history

Read

Returns merged inbound and outbound email history for jobs in the account.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

List job SMS history

Read

Returns merged inbound and outbound SMS history for jobs in the account.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

List ServiceTemplates

Read

Lists editable and published Service records, including inactive records.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

Mark message as read

Write

Marks an inbox message as read

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

A repeated request may repeat the external action. Review the previous result before retrying a write.

Produce a Templated Document

Write

Use this endpoint to combine Objects with Document Templates to produce PDF, DOCX or JPG output.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

A repeated request may repeat the external action. Review the previous result before retrying a write.

Retrieve a Badge

Read

OAuth Scope This endpoint requires the following OAuth scope readbadges.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

Retrieve a Bundle

Read

OAuth Scope This endpoint requires the following OAuth scope readinventory.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

Retrieve a Category

Read

OAuth Scope This endpoint requires the following OAuth scope readjobcategories.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

Retrieve a Client

Read

OAuth Scope This endpoint requires the following OAuth scope readcustomers.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

Retrieve a Company Contact

Read

OAuth Scope This endpoint requires the following OAuth scope readcustomercontacts.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

Retrieve a Document Template

Read

OAuth Scope This endpoint requires the following OAuth scope readtemplates.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

Retrieve a Feedback

Read

OAuth Scope This endpoint requires the following OAuth scope readfeedback.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

Retrieve a Form

Read

OAuth Scope This endpoint requires the following OAuth scope readforms.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

Retrieve a Form Field

Read

OAuth Scope This endpoint requires the following OAuth scope readforms.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

Retrieve a Form Response

Read

OAuth Scope This endpoint requires the following OAuth scope readforms.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

Retrieve a Job

Read

OAuth Scope This endpoint requires the following OAuth scope readjobs.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

Retrieve a Job Activity

Read

OAuth Scope This endpoint requires the following OAuth scope readschedule.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

Retrieve a Job Activity

Read

OAuth Scope This endpoint requires the following OAuth scope readjobadminactivity.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

Retrieve a Job Allocation

Read

OAuth Scope This endpoint requires the following OAuth scope readschedule.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

Retrieve a Job Checklist

Read

OAuth Scope This endpoint requires the following OAuth scope readjobchecklists.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

Retrieve a Job Contact

Read

OAuth Scope This endpoint requires the following OAuth scope readjobcontacts.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

Retrieve a Job Material

Read

OAuth Scope This endpoint requires the following OAuth scope readjobmaterials.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

Retrieve a Job Material Bundle

Read

OAuth Scope This endpoint requires the following OAuth scope readjobmaterials.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

Retrieve a Job Payment

Read

OAuth Scope This endpoint requires the following OAuth scope readjobpayments.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

Retrieve a Job Queue

Read

OAuth Scope This endpoint requires the following OAuth scope readjobqueues.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

Retrieve a Job Template

Read

OAuth Scope This endpoint requires the following OAuth scope readjobs.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

Retrieve a Knowledge Article

Read

OAuth Scope This endpoint requires the following OAuth scope readknowledge.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

Retrieve a Location

Read

OAuth Scope This endpoint requires the following OAuth scope readlocations.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

Retrieve a Material

Read

OAuth Scope This endpoint requires the following OAuth scope readinventory.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

Retrieve a Note

Read

OAuth Scope This endpoint requires the following OAuth scope readjobnotes.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

Retrieve a Security Role

Read

OAuth Scope This endpoint requires the following OAuth scope readsecurityroles.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

Retrieve a SMS Template

Read

OAuth Scope This endpoint requires the following OAuth scope readtemplates.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

Retrieve a Staff Member

Read

OAuth Scope This endpoint requires the following OAuth scope readstaff.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

Retrieve a Staff Message

Read

OAuth Scope This endpoint requires the following OAuth scope readmessages.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

Retrieve a Staff Time Event

Read

Staff clock-on, clock-off and lunch-break events, separate from job check-in activity.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

Retrieve a Supplier

Read

OAuth Scope This endpoint requires the following OAuth scope readsuppliers.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

Retrieve a Task

Read

OAuth Scope This endpoint requires the following OAuth scope readtasks.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

Retrieve a Tax Rate

Read

OAuth Scope This endpoint requires the following OAuth scope readtaxrates.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

Retrieve a Vendor

Read

Vendor account information OAuth Scope This endpoint requires the following OAuth scope vendor.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

Retrieve an Allocation Window

Read

OAuth Scope This endpoint requires the following OAuth scope readschedule.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

Retrieve an Asset

Read

OAuth Scope This endpoint requires the following OAuth scope readassets.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

Retrieve an Asset Type

Read

OAuth Scope This endpoint requires the following OAuth scope readassets.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

Retrieve an Asset Type Field

Read

OAuth Scope This endpoint requires the following OAuth scope readassets.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

Retrieve an Attachment

Read

OAuth Scope This endpoint requires the following OAuth scope readattachments.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

Retrieve an Availability

Read

OAuth Scope This endpoint requires the following OAuth scope readschedule.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

Retrieve an Email Template

Read

OAuth Scope This endpoint requires the following OAuth scope readtemplates.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

Search across multiple object types

Read

Performs a text search across jobs, companies, and materials.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

Search within a specific object type

Read

Performs a text search within a specific object type.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

Semantic search for jobs

Read

Harness the power of advanced AI embeddings to revolutionise how you search through job data.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

Send an Email

Write

Send an email through the ServiceM8 Messaging API.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

A repeated request may repeat the external action. Review the previous result before retrying a write.

Send an SMS Message

Write

Important: Sending messages via this endpoint will incur SMS charges.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

A repeated request may repeat the external action. Review the previous result before retrying a write.

Snooze or unsnooze message

Write

Snoozes a message until a specified date/time or unsnoozes it

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

A repeated request may repeat the external action. Review the previous result before retrying a write.

Soft-delete a ServiceTemplate

Write

Sets active=0.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

A repeated request may repeat the external action. Review the previous result before retrying a write.

Update a Badge

Write

OAuth Scope This endpoint requires the following OAuth scope managebadges.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

A repeated request may repeat the external action. Review the previous result before retrying a write.

Update a Bundle

Write

OAuth Scope This endpoint requires the following OAuth scope manageinventory.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

A repeated request may repeat the external action. Review the previous result before retrying a write.

Update a Category

Write

OAuth Scope This endpoint requires the following OAuth scope managejobcategories.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

A repeated request may repeat the external action. Review the previous result before retrying a write.

Update a Client

Write

OAuth Scope This endpoint requires the following OAuth scope managecustomers.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

A repeated request may repeat the external action. Review the previous result before retrying a write.

Update a Company Contact

Write

OAuth Scope This endpoint requires the following OAuth scope managecustomercontacts.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

A repeated request may repeat the external action. Review the previous result before retrying a write.

Update a Document Template

Write

OAuth Scope This endpoint requires the following OAuth scope managetemplates.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

A repeated request may repeat the external action. Review the previous result before retrying a write.

Update a Feedback

Write

OAuth Scope This endpoint requires the following OAuth scope managefeedback.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

A repeated request may repeat the external action. Review the previous result before retrying a write.

Update a Form

Write

OAuth Scope This endpoint requires the following OAuth scope manageforms.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

A repeated request may repeat the external action. Review the previous result before retrying a write.

Update a Form Field

Write

OAuth Scope This endpoint requires the following OAuth scope manageforms.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

A repeated request may repeat the external action. Review the previous result before retrying a write.

Update a Form Response

Write

OAuth Scope This endpoint requires the following OAuth scope manageforms.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

A repeated request may repeat the external action. Review the previous result before retrying a write.

Update a Job

Write

OAuth Scope This endpoint requires the following OAuth scope managejobs.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

A repeated request may repeat the external action. Review the previous result before retrying a write.

Update a Job Activity

Write

OAuth Scope This endpoint requires the following OAuth scope manageschedule.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

A repeated request may repeat the external action. Review the previous result before retrying a write.

Update a Job Allocation

Write

OAuth Scope This endpoint requires the following OAuth scope manageschedule.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

A repeated request may repeat the external action. Review the previous result before retrying a write.

Update a Job Checklist

Write

OAuth Scope This endpoint requires the following OAuth scope managejobchecklists.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

A repeated request may repeat the external action. Review the previous result before retrying a write.

Update a Job Contact

Write

OAuth Scope This endpoint requires the following OAuth scope managejobcontacts.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

A repeated request may repeat the external action. Review the previous result before retrying a write.

Update a Job Material

Write

OAuth Scope This endpoint requires the following OAuth scope managejobmaterials.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

A repeated request may repeat the external action. Review the previous result before retrying a write.

Update a Job Material Bundle

Write

OAuth Scope This endpoint requires the following OAuth scope managejobmaterials.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

A repeated request may repeat the external action. Review the previous result before retrying a write.

Update a Job Queue

Write

OAuth Scope This endpoint requires the following OAuth scope managejobqueues.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

A repeated request may repeat the external action. Review the previous result before retrying a write.

Update a Knowledge Article

Write

OAuth Scope This endpoint requires the following OAuth scope manageknowledge.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

A repeated request may repeat the external action. Review the previous result before retrying a write.

Update a Location

Write

OAuth Scope This endpoint requires the following OAuth scope managelocations.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

A repeated request may repeat the external action. Review the previous result before retrying a write.

Update a Material

Write

OAuth Scope This endpoint requires the following OAuth scope manageinventory.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

A repeated request may repeat the external action. Review the previous result before retrying a write.

Update a Note

Write

OAuth Scope This endpoint requires the following OAuth scope publishjobnotes.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

A repeated request may repeat the external action. Review the previous result before retrying a write.

Update a SMS Template

Write

OAuth Scope This endpoint requires the following OAuth scope managetemplates.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

A repeated request may repeat the external action. Review the previous result before retrying a write.

Update a Staff Message

Write

OAuth Scope This endpoint requires the following OAuth scope publishmessages.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

A repeated request may repeat the external action. Review the previous result before retrying a write.

Update a Supplier

Write

OAuth Scope This endpoint requires the following OAuth scope managesuppliers.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

A repeated request may repeat the external action. Review the previous result before retrying a write.

Update a Task

Write

OAuth Scope This endpoint requires the following OAuth scope managetasks.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

A repeated request may repeat the external action. Review the previous result before retrying a write.

Update a Tax Rate

Write

OAuth Scope This endpoint requires the following OAuth scope managetaxrates.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

A repeated request may repeat the external action. Review the previous result before retrying a write.

Update an Allocation Window

Write

OAuth Scope This endpoint requires the following OAuth scope manageschedule.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

A repeated request may repeat the external action. Review the previous result before retrying a write.

Update an Asset

Write

OAuth Scope This endpoint requires the following OAuth scope manageassets.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

A repeated request may repeat the external action. Review the previous result before retrying a write.

Update an Asset Type

Write

OAuth Scope This endpoint requires the following OAuth scope manageassets.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

A repeated request may repeat the external action. Review the previous result before retrying a write.

Update an Asset Type Field

Write

OAuth Scope This endpoint requires the following OAuth scope manageassets.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

A repeated request may repeat the external action. Review the previous result before retrying a write.

Update an Attachment

Write

OAuth Scope This endpoint requires the following OAuth scope manageattachments.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

A repeated request may repeat the external action. Review the previous result before retrying a write.

Update an Availability

Write

OAuth Scope This endpoint requires the following OAuth scope manageschedule.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

A repeated request may repeat the external action. Review the previous result before retrying a write.

Update an Email Template

Write

OAuth Scope This endpoint requires the following OAuth scope managetemplates.

Permissions and limits

Account permissions

A ServiceM8 API key (Settings, API Keys)

A repeated request may repeat the external action. Review the previous result before retrying a write.

SETUP

Start with a controlled test.

01Connect the intended account

Use the account and permissions required for your process. Review the connection check before configuring a workflow action.

02Review inputs and access

Select a listed operation and map its required inputs. Use test records and add a human approval before writes that need review.

03Confirm the result

Inspect step outputs and confirm the result in ServiceM8. A saved workflow is not a completed provider action.

Follow the workflow quickstart

EXPLORE YOUR STACK