workwing-io Job types API
Job types (read-only). The collection is `job_templates`, and a job's `template_id` points at one.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/workwing-io:workwing-io-job-types-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: WorkWing Job types API
description: 'REST API for WorkWing field service management. Designed as an **integration point** for CRM, ERP, and dispatch systems. Admin configuration (webhooks, roles, job types, integrations) is managed via the web dashboard. Every resource is documented under its own section in the sidebar. ## Authentication
Send your API key as a bearer token on every request:
```
Authorization: Bearer ww_sk_live_. ```
### Scopes
An API key carries a list of `action:resource` scopes. Every operation publishes the ones it requires as `x-required-scopes`, an array on the operation object; a key must hold all of them, or the wildcard scope `*`, and one that does not is refused with `403 E_AP_1102`. The two operations that declare `security: []` need no key at all: the health check, and the integration callback, which authenticates with the signed token in its own path. ## Querying collections
List endpoints (jobs, customers, resources, and so on) accept query parameters for filtering, sorting, field selection, and pagination:
- `?status=eq.T_PENDING` - filter by exact match
- `?priority=in.(T_HIGH,T_URGENT)` - match any of several values
- `?created_at=gte.2024-01-01` - range comparisons (`gt`, `gte`, `lt`, `lte`)
- `?select=id,status,customer:customers(name)` - choose columns and embed related records. Only the resources listed here, the assignments and users they reference, and the foreign keys between them can be embedded; anything else is refused with `E_AP_6003`
- `?order=created_at.desc` - sort (append `.asc` / `.desc`)
- `?limit=25&offset=50` - paginate (maximum 1000 rows per page)
### Columns not available over the API
Some columns are never returned: `tenant_id` on every resource (a key is bound to one tenant), `internal_notes` on jobs (staff-only; it can be set with `PATCH`, and a job''s note timeline is at `GET /v1/jobs/{jobId}/notes`), and the raw PostGIS geography columns `customers.location`, `locations.location` and `resources.current_location`. Read a position from `latitude`/`longitude` on locations and `current_latitude`/`current_longitude` on resources instead. `select=*`, at the top level or inside an embed, returns every other column. Naming one of these columns in `select`, a filter or `order` is refused with `E_AP_6003`. To read, update or delete one record, address it by id: `GET`, `PATCH` or `DELETE /v1/jobs/{jobId}` (likewise customers, resources and locations). `PATCH` and `DELETE` on a collection change every row matching its filters, e.g. `PATCH /v1/jobs?status=eq.T_PENDING`; they are listed under Workflows. ### Counting and paging
Send `Prefer: count=exact` on a list request to get the total row count back in the `Content-Range` response header (`0-24/312`). `count=planned` and `count=estimated` are cheaper approximations for large tables. ## Idempotency
**Guarantee.** Within 24 hours, a write sent with a given `Idempotency-Key` is applied at most once. If you did not receive a response, retrying with the same key and the same request is always safe. **Core rule.** A key is consumed only when the write is actually applied. The key and the write commit in the same database transaction, so they succeed or fail together. Every write request (`POST`, `PATCH`, `PUT`, `DELETE`) must send an `Idempotency-Key` header. | Situation | Response | Write applied?'
version: 1.0.0
servers:
- url: https://api.workwing.io
description: Production
security:
- bearerAuth: []
tags:
- name: Job types
description: Job types (read-only). The collection is `job_templates`, and a job's `template_id` points at one.
paths:
/v1/job_templates:
get:
operationId: listJobTemplates
summary: List job types
tags:
- Job types
description: 'List job types (read-only).
- `?is_active=is.true` - Only active job types
- `?select=id,name,description,default_priority` - Field selection
- `?order=name.asc` - Sorting'
parameters:
- schema:
type: string
in: query
name: select
required: false
description: 'Comma-separated columns to return. Supports embedded resources: `*,customer:customers(name,email)`'
- schema:
type: string
in: query
name: order
required: false
description: Sort order, e.g. `created_at.desc` or `name.asc`
- schema:
type: integer
in: query
name: limit
required: false
description: Maximum number of rows to return (max 1000)
- schema:
type: integer
in: query
name: offset
required: false
description: Number of rows to skip for pagination
security:
- bearerAuth: []
x-required-scopes:
- read:job_templates
x-postgrest-passthrough: true
responses:
'200':
description: Array of job types
content:
application/json:
schema:
description: Array of job types
type: object
properties:
data:
type: array
items:
type: object
properties:
id:
type: string
format: uuid
brand_id:
type: string
format: uuid
name:
type: string
description: Job type name
description:
type:
- string
- 'null'
is_active:
type:
- boolean
- 'null'
default_priority:
type:
- string
- 'null'
enum:
- T_LOW
- T_NORMAL
- T_HIGH
- T_URGENT
- null
estimated_duration_minutes:
type:
- integer
- 'null'
operator_form_config:
type:
- object
- 'null'
additionalProperties: true
description: 'EntityLayoutConfig: {version, formColumns, components} - canonical layout for the operator-facing form'
resource_form_config:
type:
- object
- 'null'
additionalProperties: true
description: 'EntityLayoutConfig: {version, formColumns, components} - canonical layout for the resource form'
version:
type: integer
sla_config:
type:
- object
- 'null'
additionalProperties: true
description: Response and resolution targets applied to jobs created from the job type
quickview_fields:
type:
- array
- 'null'
items:
type: object
additionalProperties: true
description: The job type fields shown in a job's quick view
allow_extra_parts:
type: boolean
description: Whether a resource may add parts the job type does not list
job_sheet_auto_send:
type: boolean
description: Whether the customer is emailed the job sheet PDF automatically on completion
job_sheet_fields:
type: object
additionalProperties:
type: boolean
description: 'Per-field overrides of what the job sheet shows. Keys are `operator:<fieldKey>` or `resource:<fieldKey>`, naming the form (office or engineer) and the field''s key in it; values are true to include the field and false to leave it out. A field with no key here follows the default: engineer (resource) form fields are included, office (operator) form fields are not.'
created_by_user_id:
type:
- string
- 'null'
format: uuid
created_at:
type:
- string
- 'null'
format: date-time
updated_at:
type:
- string
- 'null'
format: date-time
meta:
type: object
properties:
request_id:
type: string
timestamp:
type: string
format: date-time
/v1/job-templates/{templateId}/stats:
get:
operationId: getJobTemplateStats
summary: Get job type stats
tags:
- Job types
description: Get a job type with usage statistics including job counts by status
parameters:
- schema:
type: string
format: uuid
in: path
name: templateId
required: true
security:
- bearerAuth: []
x-required-scopes:
- read:job_templates
responses:
'200':
description: Default Response
content:
application/json:
schema:
type: object
required:
- data
- meta
properties:
data:
type: object
required:
- id
- brand_id
- name
- description
- default_priority
- estimated_duration_minutes
- is_active
- version
- allow_extra_parts
- job_sheet_auto_send
- job_sheet_fields
- operator_form_config
- resource_form_config
- quickview_fields
- sla_config
- created_by_user_id
- created_at
- updated_at
- stats
properties:
id:
type: string
format: uuid
brand_id:
type: string
format: uuid
name:
type: string
description:
type:
- string
- 'null'
default_priority:
type:
- string
- 'null'
description: One of T_LOW, T_NORMAL, T_HIGH, T_URGENT.
estimated_duration_minutes:
type:
- integer
- 'null'
is_active:
type:
- boolean
- 'null'
version:
type: integer
allow_extra_parts:
type: boolean
description: Whether engineers can add parts to this job type's jobs from the mobile app.
job_sheet_auto_send:
type: boolean
description: Whether the customer is emailed the job sheet PDF automatically on completion
job_sheet_fields:
type: object
additionalProperties:
type: boolean
description: 'Per-field overrides of what the job sheet shows. Keys are `operator:<fieldKey>` or `resource:<fieldKey>`, naming the form (office or engineer) and the field''s key in it; values are true to include the field and false to leave it out. A field with no key here follows the default: engineer (resource) form fields are included, office (operator) form fields are not.'
operator_form_config:
description: The form definition (version, components, formColumns). Null when the job type has none.
resource_form_config:
description: The form definition (version, components, formColumns). Null when the job type has none.
quickview_fields:
description: The fields shown in the job quick view. Null when unset.
sla_config:
description: SLA targets for jobs created from this job type. Null when the job type has no SLA.
created_by_user_id:
type:
- string
- 'null'
format: uuid
created_at:
type:
- string
- 'null'
format: date-time
updated_at:
type:
- string
- 'null'
format: date-time
stats:
type: object
required:
- total_jobs
- active_jobs
- completed_jobs
- cancelled_jobs
- failed_jobs
properties:
total_jobs:
type: integer
minimum: 0
active_jobs:
type: integer
minimum: 0
description: Jobs in any status that is not completed, cancelled or failed.
completed_jobs:
type: integer
minimum: 0
cancelled_jobs:
type: integer
minimum: 0
failed_jobs:
type: integer
minimum: 0
meta:
type: object
required:
- request_id
- timestamp
properties:
request_id:
type: string
timestamp:
type: string
format: date-time
components:
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: API Key
description: 'Use your WorkWing API key (format: `ww_sk_live_<tokenId>.<secret>`). The scopes an operation requires are published on it as `x-required-scopes`.'