Developers · MCP & REST API

Connect ZimQi to your AI assistant or scripts

Every plan — including the 30-day free trial, up to 300 credits — includes our live MCP server, REST API (/api/v1) and interactive OpenAPI docs with no extra credits for API calls. Assistants inherit the same role permissions as the person who created the key. A ChatGPT app is not listed yet.

View API docs (Swagger) OpenAPI JSON Create an API key Start free trial

What is MCP, in plain words?

MCP (Model Context Protocol) is a standard way for AI apps to call tools on your systems — a bit like giving your assistant a secure remote control, not free rein of your database.

ZimQi’s MCP tools go through the same service layer as Telegram and the web app: plan limits, role checks, and audit. Your assistant can suggest and run the actions your key allows. It does not get a back door.

Example prompts

Things people actually ask once a key is connected:

  • “Who’s on site at 11 Brighton St right now?”
  • “Show Jack’s hours for the last 2 weeks.”
  • “Add a site called Warehouse B, job number W-204.”
  • “Assign Mia and Sam to the CBD clean for ongoing.”
  • “Log sick leave for Liam tomorrow and find available cover with a White Card.”
  • “List any in-progress Smart Forms on Harbour St or expiring crew licences in the next 30 days.”

Approvals stay with a named human in Telegram or the dashboard. The assistant won’t approve timesheets, change billing or silently rewrite someone else’s clock times.

Use ZimQi in Claude and other MCP clients

ZimQi is available in the Claude directory. In Claude, open the listing and choose Connect.

Or add ZimQi as a custom connector. You sign in to ZimQi and approve access. There’s no API key to copy.

  1. In Claude (Settings › Connectors › Add custom connector) or ChatGPT (Settings › Apps, with developer mode on), add this server URL:
    https://zimqi.com.au/mcp
  2. Click Connect. A ZimQi page opens titled “Connect with ZimQi”.
  3. Sign in, or start the 30-day free trial, up to 300 credits (no card), then choose Allow.

Included on every plan and the free trial, with the same site and crew limits and no extra credits. Custom connectors in ChatGPT depend on your ChatGPT plan; check OpenAI’s current availability.

What the assistant can read and change

  • Read: sites, crew (including worker type, skills & licences), site assignments, leave & available cover, Smart Forms & site records (including paused drafts), who’s checked in today, attendance logs, timesheets, and timesheet and payroll CSV exports.
  • Change (owners and managers only): add or update sites and crew, manage worker skills and licence/insurance renewals, assign or remove people from sites, log or cancel leave, create or edit Smart Form questions, save or submit form entries, prepare draft subcontractor bills, check people in or out, mark someone absent, and propose a timesheet correction for a person to approve.
  • Bookkeepers’ connections are read-only. The assistant can’t approve timesheets or touch billing.
  • You choose what to allow on the ZimQi consent screen, and the connection uses your role’s permissions.
  • Disconnect any time: Integrations & API › Connected apps › Disconnect. The assistant loses access straight away.

What you ask the assistant, and the ZimQi data it reads to answer, is also handled by Anthropic or OpenAI under their own terms. See our privacy policy. Questions: support@zimqi.com.au.

Keys and roles

Every signed-in person can create their own API key. The key carries that person’s role:

  • Owner / supervisor — Full access (same as you): sites, crew, check-in/out.
  • Bookkeeper / worker — Read only by default.

Owners can see and revoke every key in the company. Everyone else manages only the keys they created. Same site and crew limits as your plan — no extra credits for MCP or REST calls.

REST API & OpenAPI

  1. Sign in to ZimQi (trial is fine).
  2. Open Integrations & API in the sidebar.
  3. Create an API key and copy it once.
  4. Connect your MCP client to https://zimqi.com.au/mcp or call /api/v1 with Authorization: Bearer ….

Open Swagger docs OpenAPI JSON

Bring Your Own AI (BYO-AI)

Connect your own Google Gemini, Claude (Anthropic), ChatGPT (OpenAI), or Grok (xAI) via MCP or paste a verified API key under Integrations & API. Smart Form imports and document checks* run on your own AI account for 0 ZimQi credits.

*Completed and saved in ZimQi — not a certification, and not compliance on its own. Notes