# WorkWing

> WorkWing is field service management software: jobs, engineers, customers and
> scheduling, with a web dashboard for dispatchers and a mobile app for people in
> the field. It is a scheduling and job-execution system, not an invoicing or CRM
> product. Operated by Littlebourne Labs Ltd (England and Wales, company number
> 17119449).

WorkWing can be driven by an AI assistant over the Model Context Protocol. The
connector URL is https://api.workwing.io/mcp. It authenticates with OAuth 2.1:
the user signs in at https://auth.workwing.io and approves a consent screen, and
the assistant then acts as that user, inside that user's organisation and permissions.
It can look up customers, engineers, schedules and jobs, and can create jobs,
book engineers, add notes and cancel jobs. It cannot delete anything, touch
billing, manage people or change settings.

## Docs

- [Getting started](https://docs.workwing.io/getting-started/introduction/): concepts, first setup, first job.
- [First-time setup](https://docs.workwing.io/getting-started/first-time-setup/): the path from a new organisation to dispatching work.
- [Guides](https://docs.workwing.io/guides/go-live-checklist/): task-based walkthroughs: building a job type, importing customers and work, multi-brand setup, subcontractors, connecting another system, and a go-live checklist.
- [AI assistants (MCP)](https://docs.workwing.io/integrations/ai-assistants/): connecting Claude or ChatGPT, what the assistant can and cannot do, how to disconnect.
- [Jobs](https://docs.workwing.io/jobs/overview/): the job lifecycle, statuses and scheduling.
- [Resources](https://docs.workwing.io/resources/overview/): engineers, skills, availability and absences.
- [Customers](https://docs.workwing.io/customers/overview/): customers, their locations and their history.
- [Projects](https://docs.workwing.io/projects/overview/): batches of jobs sharing a window and a crew, worked from a claim pool.
- [Observations](https://docs.workwing.io/observations/overview/): what engineers report from site, and how the office triages it.
- [Job types](https://docs.workwing.io/templates/overview/): job types (`job_templates` in the API) and the form builder.
- [Reports](https://docs.workwing.io/reports/dashboard/): job volume, completion, SLA compliance and utilisation.
- [Mobile app](https://docs.workwing.io/mobile/overview/): what engineers use in the field, including offline working.
- [Integrations](https://docs.workwing.io/integrations/overview/): custom HTTP integrations, the marketplace, execution history.
- [Settings](https://docs.workwing.io/settings/members/): members, roles, security, custom fields, privacy tools and the rest of the organisation-wide configuration.

## API

- [OpenAPI spec](https://docs.workwing.io/openapi.json): the machine-readable REST API description (OpenAPI 3.0). Read this, not the reference page, to write code against the API.
- [API getting started](https://docs.workwing.io/api/getting-started/): keys, permissions, idempotency, the response envelope, errors, filtering and paging.
- [API recipes](https://docs.workwing.io/api/recipes/create-and-schedule-a-job/): end-to-end examples: create and schedule a job, idempotent creation, error handling, a nightly customer sync, receiving a completed-job webhook, syncing completed jobs out, and connecting an AI assistant safely.
- [Webhooks](https://docs.workwing.io/settings/webhooks/): events, payloads, signature verification and retries.
- [API overview and reference](https://docs.workwing.io/api/): auth, idempotency, errors, rate limits, webhooks and the core resources, then the same spec rendered for a browser (the reference half needs JavaScript).

Essentials for writing an integration: base URL https://api.workwing.io/v1;
send `Authorization: Bearer <api key>`; every POST, PATCH, PUT and DELETE needs
an `Idempotency-Key` header; successful responses are `{ "data": ..., "meta": ... }`;
jobs, customers, resources and locations are fetched, updated and deleted by id
at `/v1/<collection>/{id}`; lists filter with `?column=operator.value`
(e.g. `?status=eq.T_PENDING`) and page with `limit` and `offset`.