Be the first to get access to new connectors. Get early access →
ConnectorBay Early access

ServiceM8 (BYOK) — connector documentation

  • MCP endpoint: https://byok-servicem8.connectorbay.com/mcp
  • REST API: POST https://byok-servicem8.connectorbay.com/v1/tools/{tool_name}, described by the OpenAPI 3.1 spec at https://byok-servicem8.connectorbay.com/openapi.json
  • Transport: Streamable HTTP, stateless, MCP specification 2025-06-18 or later
  • Authentication: your own ServiceM8 ServiceM8 API key, sent in the X-Upstream-Key header of every request (never stored, logged or cached)
  • Health: https://byok-servicem8.connectorbay.com/health · Tool schemas: https://byok-servicem8.connectorbay.com/tools.json
  • Publisher: Unify Dynamics LLC · connectorbay.com/byok-servicem8 · agent@connectorbay.com

What ServiceM8 (BYOK) is for

ServiceM8 (BYOK) lets an AI assistant read your own ServiceM8 data through the ServiceM8 API with a key you supply (ServiceM8 API key). Read-only: 10 tools (list_jobs, list_clients, list_staff, list_job_activities, list_job_allocations, list_job_payments, list_job_materials, list_job_queues, list_categories, list_locations). The BYOK key travels with each request, is used for that one call only and is never stored, logged or cached; it is only ever sent to api.servicem8.com. Unofficial connector by Unify Dynamics LLC: not affiliated with, endorsed by or sponsored by ServiceM8. ServiceM8 and its logos are trademarks of their owners and are used only to say which service the connector works with.

Ask your assistant things like:

  • "Which ServiceM8 jobs are currently work orders?"
  • "Find the ServiceM8 client named Smith & Sons"
  • "Who is on the ServiceM8 field team?"
  • "What visits are scheduled in ServiceM8 for job abc?"
  • "Who is each ServiceM8 job allocated to?"
  • "What payments were recorded in ServiceM8 recently?"

What it does

  • list_jobs: List jobs (quotes, work orders, completed) with status, address, description, client, invoice total and dates. The API returns records in its own order; narrow with the filter.
  • list_clients: List clients (customer companies and individuals) with name, address, website and active flag.
  • list_staff: List staff members with name, job title, schedule visibility and active flag (no contact details or live location).
  • list_job_activities: List scheduled or recorded job activities (visits) with staff, start and end times and travel time.
  • list_job_allocations: List which staff member or queue each job is allocated to, with allocation date and completion time.
  • list_job_payments: List payments recorded against jobs with amount, method, time and whether it was a deposit.
  • list_job_materials: List materials and line items added to jobs with name, quantity and price.
  • list_job_queues: List job queues (inboxes) with name, default timeframe and whether assignment is required.
  • list_categories: List job categories with name and colour.
  • list_locations: List business locations (depots, warehouses) with name, address and coordinates.

BYOK key

You bring your own ServiceM8 ServiceM8 API key (https://developer.servicem8.com/docs/authentication). Your assistant sends it in the X-Upstream-Key header with each request. ConnectorBay uses it for that one call only: it is never stored, logged or cached, never shown in an answer, and it is only sent to api.servicem8.com over https, with no redirects followed. Create a key with the fewest permissions the tools need (read-only if the provider offers it), and revoke it at the provider whenever you like.

Data sources

Live from the ServiceM8 API (api.servicem8.com) with a BYOK key; documentation: https://developer.servicem8.com/docs/rest-overview. Endpoints checked against that documentation on 2026-10-16.

What it is not

Unofficial connector by Unify Dynamics LLC: not affiliated with, endorsed by or sponsored by ServiceM8. ServiceM8 and its logos are trademarks of their owners and are used only to say which service the connector works with. It is read-only: it never creates, changes, sends or deletes anything in your ServiceM8 account.

Built for: Worldwide. Languages: English.