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

ServiceM8 Forms (BYOK) — connector documentation

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

What ServiceM8 Forms (BYOK) is for

ServiceM8 Forms (BYOK) lets an AI assistant read your own ServiceM8 Forms data through the ServiceM8 Forms API with a key you supply (ServiceM8 API key). Read-only: 6 tools (list_forms, list_form_fields, list_badges, list_allocation_windows, list_availabilities, list_job_checklists). 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 Forms. ServiceM8 Forms 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 forms can staff fill in on ServiceM8 jobs?"
  • "What questions are on ServiceM8 form abc?"
  • "Which badges exist in ServiceM8?"
  • "What allocation windows are configured in ServiceM8?"
  • "When is staff unavailable in ServiceM8 next week?"
  • "Which checklist items on ServiceM8 job abc are still open?"

What it does

  • list_forms: List form definitions with name, linked document template, standalone-use flag and badge settings.
  • list_form_fields: List the questions of forms with form, question name, configuration JSON and sort order. Filter by form_uuid to read one form.
  • list_badges: List job badges with name, whether they are allocated automatically and any linked form or asset type.
  • list_allocation_windows: List allocation windows (named time slots such as morning or afternoon) with start and end in minutes from midnight and sort priority.
  • list_availabilities: List availability records (for example staff unavailable or available periods) with type, start and end time and source.
  • list_job_checklists: List job checklist items with job, item name, section, type, sort order and completion time (no staff names).

BYOK key

You bring your own ServiceM8 Forms 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 Forms API (api.servicem8.com) with a BYOK key; documentation: https://developer.servicem8.com/reference/listforms. 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 Forms. ServiceM8 Forms 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 Forms account.

Built for: Worldwide. Languages: English.