workwing-io Context API
API key introspection, capabilities, and organisation info
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-context-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 Context 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: Context
description: API key introspection, capabilities, and organisation info
paths:
/v1/capabilities:
get:
operationId: listCapabilities
summary: List all system capabilities
tags:
- Context
description: Returns all system capabilities (permissions). Useful for building permission UIs or understanding available scopes.
security:
- bearerAuth: []
x-required-scopes:
- read:tenant
responses:
'200':
description: Default Response
content:
application/json:
schema:
type: object
required:
- data
- meta
properties:
data:
type: array
items:
type: object
required:
- id
- name
- description
- resource
- action
- scope
properties:
id:
type: string
format: uuid
name:
type: string
description: '`resource:action`'
description:
type:
- string
- 'null'
resource:
type: string
action:
type: string
scope:
type: string
enum:
- T_BRAND
- T_TENANT
description: Whether the capability is granted per brand or tenant-wide
meta:
type: object
required:
- request_id
- timestamp
- count
properties:
request_id:
type: string
timestamp:
type: string
format: date-time
count:
type: integer
/v1/me:
get:
operationId: getApiKeyContext
summary: Get current API key context
tags:
- Context
description: Returns organisation, brand, scopes, and key metadata for the authenticated API key. Useful for verifying connectivity and permissions.
security:
- bearerAuth: []
x-required-scopes:
- read:tenant
responses:
'200':
description: Default Response
content:
application/json:
schema:
type: object
required:
- data
- meta
properties:
data:
type: object
required:
- tenant
- brand
- user_id
- key_id
- scopes
properties:
tenant:
type: object
required:
- id
- name
- slug
- created_at
properties:
id:
type: string
format: uuid
name:
type: string
slug:
type: string
created_at:
type:
- string
- 'null'
format: date-time
brand:
type: object
description: The brand the API key is bound to
required:
- id
- name
- slug
- is_active
properties:
id:
type: string
format: uuid
name:
type: string
slug:
type: string
is_active:
type: boolean
user_id:
type: string
format: uuid
description: The user the API key acts as
key_id:
type:
- string
- 'null'
format: uuid
description: The API key's id. Null when the request was authenticated with a user token rather than an API key.
scopes:
type: array
items:
type: string
description: The scopes granted to the API key, e.g. read:jobs
meta:
type: object
required:
- request_id
- timestamp
properties:
request_id:
type: string
timestamp:
type: string
format: date-time
/v1/tenant:
get:
operationId: getTenant
summary: Get current organisation info
tags:
- Context
description: Returns the id, name, slug and creation time of the organisation associated with the API key
security:
- bearerAuth: []
x-required-scopes:
- read:tenant
responses:
'200':
description: Default Response
content:
application/json:
schema:
type: object
required:
- data
- meta
properties:
data:
type: object
required:
- id
- name
- slug
- created_at
properties:
id:
type: string
format: uuid
name:
type: string
slug:
type: string
created_at:
type:
- string
- 'null'
format: date-time
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`.'