ServiceM8 API Documentation

This is the complete API documentation for connecting to the ServiceM8 API using MindCloud's Universal API. If you are new to MindCloud, start with the Introduction to see how one API can sit in front of many different apps.

MindCloud is an integration company that offers one normalized API to access 3,100+ apps from a single place. It cleans up provider-specific quirks, keeps requests and responses consistent, and centralizes authentication so you do not need to manage separate flows for every app. Browse other apps.

Meet ServiceM8: Manage field service jobs, clients, staff, and job templates. Keep reading to get started.

Quickstart

Before you run your first ServiceM8 request, you need three things:

1. A MindCloud account — sign in or create an account at MindCloud.
2. A MindCloud API Key — create one in API Keys. Keep it on your server.
3. At least one ServiceM8 connection — create or choose one in Connections. Note its connectionId.

Every ServiceM8 action uses the same URL pattern:

POST https://connect.mindcloud.co/v2/universal/apps/serviceM8/actions/{actionSlug}/run

You need a MindCloud API Key and a ServiceM8 connection. Then call an action such as List Clients:

curl --request POST \
  --url "https://connect.mindcloud.co/v2/universal/apps/serviceM8/actions/list-clients/run" \
  --header "Authorization: Bearer $MINDCLOUD_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
  "connectionId": "$CONNECTION_ID",
  "arguments": {}
}'

Every response comes back in the same envelope, with your rows in a data array:

{
  "success": true,
  "data": [
    { "id": "1042", "name": "Ava" }
  ],
  "meta": {}
}

After your first request works, use Shape your requests to control arguments, pagination, filtering, fields, and errors.

Authenticate with a MindCloud API Key plus a connectionId for your ServiceM8 account. See ServiceM8 API Authentication for the full flow and how to get your connection credentials.

ServiceM8 actions

All 22 published actions for this ServiceM8 version. Each page documents the endpoint, arguments, and response controls.

• POSTCreate Client
• POSTCreate Company Contact
• POSTCreate Job
• POSTCreate Job Activity
• POSTCreate Job Allocation
• POSTCreate Task
• GETGet Client
• GETGet Job
• GETGet Staff Member
• GETList Clients
• GETList Company Contacts
• GETList Job Activities
• GETList Job Allocations
• GETList Jobs
• GETList Staff Members
• GETList Tasks
• PUTUpdate Client
• PUTUpdate Company Contact
• PUTUpdate Job
• PUTUpdate Job Activity
• PUTUpdate Staff Member
• PUTUpdate Task

Related apps

More Support apps on the Universal API, behind the same REST shape. Or browse all apps.

TrelloClickUpZendeskQuoIntercomEventbriteTickTickLinear