ServiceM8 API Filtering, Fields & Errors
ServiceM8 API filtering with where and sort, field selection, and stable error codes — one request shape via MindCloud.
Once your first ServiceM8 request works, use this page to shape real production requests. MindCloud keeps the app-specific API details behind one REST format, so you can control arguments, pagination, filtering, fields, and errors without learning a separate convention for every provider. If you have not connected ServiceM8 yet, start with Connect to ServiceM8.
Arguments
Arguments are the inputs an action needs. Put them in the JSON body under the arguments field. Each ServiceM8 action page documents its exact argument keys and types. It also shows which arguments are required. Keys are case-sensitive. Requests with missing or invalid required arguments fail.
Request format
Choose a ServiceM8 action and send a POST request to its Universal API run URL. Authenticate with your MindCloud API Key. Put the connection, arguments, and response controls in the JSON body.
| Piece | Where it goes |
|---|---|
arguments | An object in the JSON body. Put all action fields inside it. |
connectionId | An optional public connection id in the JSON body. The API selects the default or only valid connection when omitted. |
limit, offset, where, sort, fields | Response controls in the JSON body. |
Filtering
Filterable list actions accept a where body field written as an RSQL expression. MindCloud translates it into the filtering shape ServiceM8 supports. Each action page lists its filterable fields.
| Operator | Meaning | Example |
|---|---|---|
== / != | Equals / does not equal | status==active |
> >= < <= | Comparisons | createdAt>=2026-01-01 |
=like= | Contains text, with * wildcards | name=like=*dan* |
Combine conditions with ; for AND and , for OR: status==active;createdAt>=2026-01-01.
These ServiceM8 actions support filtering:
Sorting
Sortable list actions accept a sort body field. Use a comma-separated list of fields with a - prefix for descending order, such as sort=-createdAt,name. MindCloud maps it into the sorting format ServiceM8 supports, and the sortable fields are listed on each action page.
These ServiceM8 actions support sorting:
- List Clients
- List Company Contacts
- List Job Activities
- List Job Allocations
- List Jobs
- List Staff Members
- List Tasks
Field selection
Use the fields body field to return only the response fields your code reads. Use dot notation for nested objects: fields=id,name,profile.email. Selection is applied to each row in data after the response is mapped, and id is kept whenever it exists so rows stay identifiable.
Responses and errors
Every ServiceM8 response is mapped into the same public envelope before it reaches your code: success, your rows in a data array (single-row actions return an array with one item), and optional meta. Failed requests return success: false with a stable code to branch on and a human-readable message:
{
"success": false,
"code": "CONNECTION_APP_MISMATCH",
"message": "Connection \"conn_123\" is not configured for this app."
}Check the HTTP status first: 401 or 403 for authentication and authorization, 400 for invalid request shape, and 5xx when MindCloud cannot complete the action upstream. Most failures come from a missing API Key, a missing or mismatched connection, or arguments that do not match the action page.