Projects: jobs that own a pool of jobs, with their window, crew, and progress. A project is a job, so it is updated with `PATCH /v1/jobs/{jobId}` and crew is added with `POST /v1/jobs/{jobId}/assignments`, using the project's id.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
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.curl "https://apis.io/api/v1/apis/workwing-io:workwing-io-projects-api"curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
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: 3.2.0
info:
title: WorkWing Projects 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: Projects
description: 'Projects: jobs that own a pool of jobs, with their window, crew, and progress. A project is a job, so it is updated with `PATCH /v1/jobs/{jobId}` and crew is added with `POST /v1/jobs/{jobId}/assignments`, using the project''s id.'
paths:
/v1/projects:
get:
operationId: listProjects
summary: List projects
tags:
- Projects
description: 'List projects with their window, progress counts and crew. Use `GET /v1/jobs?project_id={id}` for a project''s jobs. Scope: `read:jobs`.'
parameters:
- schema:
type: string
format: uuid
in: query
name: customer_id
required: false
- schema:
type: string
in: query
name: status
required: false
- schema:
type: integer
minimum: 1
maximum: 250
in: query
name: limit
required: false
- schema:
type: integer
minimum: 0
in: query
name: offset
required: false
security:
- bearerAuth: []
x-required-scopes:
- read:jobs
responses:
'200':
description: Default Response
content:
application/json:
schema:
type: object
required:
- data
- meta
properties:
data:
type: array
items:
type: object
properties:
id:
type: string
format: uuid
job_number:
type:
- string
- 'null'
description: Human-readable project identifier (PRJ0001 by default)
title:
type:
- string
- 'null'
description: Optional name for the project, shown instead of its number
kind:
type: string
enum:
- T_PROJECT
status:
type: string
priority:
type:
- string
- 'null'
customer_id:
type: string
format: uuid
customer_name:
type:
- string
- 'null'
brand_id:
type: string
format: uuid
location_id:
type:
- string
- 'null'
format: uuid
template_id:
type:
- string
- 'null'
format: uuid
scheduled_start:
type:
- string
- 'null'
format: date-time
scheduled_end:
type:
- string
- 'null'
format: date-time
notes:
type:
- string
- 'null'
child_count:
type: integer
description: Jobs currently attached to this project
child_completed_count:
type: integer
description: Attached jobs in a completed state
created_at:
type:
- string
- 'null'
format: date-time
updated_at:
type:
- string
- 'null'
format: date-time
crew:
type: array
description: Resources assigned to the project itself. Only crew may claim its jobs.
items:
type: object
properties:
resource_id:
type: string
format: uuid
resource_name:
type:
- string
- 'null'
assignment_status:
type: string
meta:
type: object
required:
- request_id
- timestamp
properties:
request_id:
type: string
timestamp:
type: string
format: date-time
post:
operationId: createProject
summary: Create a project
tags:
- Projects
description: 'Create a project: a job that owns a pool of jobs. A job created inside it takes the project''s customer, brand and default location, and joins the pool unscheduled - it inherits no window, and only shows one once it is pinned to its own.
Projects never count toward job usage - only the jobs inside them meter.
`crew_resource_ids` attaches the engineers who may claim jobs from the pool; it needs the key creator to hold the `jobs:assign` capability.
Requires `Idempotency-Key`. Scopes: `create:jobs` and `read:jobs` (the project is read back in the response).'
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- customer_id
properties:
customer_id:
type: string
format: uuid
title:
type: string
maxLength: 200
description: Optional name for the project, shown instead of its number.
brand_id:
type: string
format: uuid
description: Optional. Must match the API key's own brand when given.
location_id:
type: string
format: uuid
template_id:
type: string
format: uuid
description: Optional sign-off job type for the project itself.
scheduled_start:
type: string
format: date-time
scheduled_end:
type: string
format: date-time
priority:
type: string
enum:
- T_LOW
- T_NORMAL
- T_HIGH
- T_URGENT
notes:
type: string
crew_resource_ids:
type: array
items:
type: string
format: uuid
security:
- bearerAuth: []
x-required-scopes:
- create:jobs
- read:jobs
responses:
'201':
description: Default Response
content:
application/json:
schema:
type: object
required:
- data
- meta
properties:
data:
type: object
properties:
id:
type: string
format: uuid
job_number:
type:
- string
- 'null'
description: Human-readable project identifier (PRJ0001 by default)
title:
type:
- string
- 'null'
description: Optional name for the project, shown instead of its number
kind:
type: string
enum:
- T_PROJECT
status:
type: string
priority:
type:
- string
- 'null'
customer_id:
type: string
format: uuid
customer_name:
type:
- string
- 'null'
brand_id:
type: string
format: uuid
location_id:
type:
- string
- 'null'
format: uuid
template_id:
type:
- string
- 'null'
format: uuid
scheduled_start:
type:
- string
- 'null'
format: date-time
scheduled_end:
type:
- string
- 'null'
format: date-time
notes:
type:
- string
- 'null'
child_count:
type: integer
description: Jobs currently attached to this project
child_completed_count:
type: integer
description: Attached jobs in a completed state
created_at:
type:
- string
- 'null'
format: date-time
updated_at:
type:
- string
- 'null'
format: date-time
crew:
type: array
description: Resources assigned to the project itself. Only crew may claim its jobs.
items:
type: object
properties:
resource_id:
type: string
format: uuid
resource_name:
type:
- string
- 'null'
assignment_status:
type: string
meta:
type: object
required:
- request_id
- timestamp
properties:
request_id:
type: string
timestamp:
type: string
format: date-time
parameters:
- $ref: '#/components/parameters/IdempotencyKey'
/v1/projects/{projectId}:
get:
operationId: getProject
summary: Get a project
tags:
- Projects
description: 'Fetch one project with its window, progress counts and crew. Scope: `read:jobs`.'
parameters:
- schema:
type: string
format: uuid
in: path
name: projectId
required: true
security:
- bearerAuth: []
x-required-scopes:
- read:jobs
responses:
'200':
description: Default Response
content:
application/json:
schema:
type: object
required:
- data
- meta
properties:
data:
type: object
properties:
id:
type: string
format: uuid
job_number:
type:
- string
- 'null'
description: Human-readable project identifier (PRJ0001 by default)
title:
type:
- string
- 'null'
description: Optional name for the project, shown instead of its number
kind:
type: string
enum:
- T_PROJECT
status:
type: string
priority:
type:
- string
- 'null'
customer_id:
type: string
format: uuid
customer_name:
type:
- string
- 'null'
brand_id:
type: string
format: uuid
location_id:
type:
- string
- 'null'
format: uuid
template_id:
type:
- string
- 'null'
format: uuid
scheduled_start:
type:
- string
- 'null'
format: date-time
scheduled_end:
type:
- string
- 'null'
format: date-time
notes:
type:
- string
- 'null'
child_count:
type: integer
description: Jobs currently attached to this project
child_completed_count:
type: integer
description: Attached jobs in a completed state
created_at:
type:
- string
- 'null'
format: date-time
updated_at:
type:
- string
- 'null'
format: date-time
crew:
type: array
description: Resources assigned to the project itself. Only crew may claim its jobs.
items:
type: object
properties:
resource_id:
type: string
format: uuid
resource_name:
type:
- string
- 'null'
assignment_status:
type: string
meta:
type: object
required:
- request_id
- timestamp
properties:
request_id:
type: string
timestamp:
type: string
format: date-time
components:
parameters:
IdempotencyKey:
name: Idempotency-Key
in: header
required: true
description: Unique per write, 1-256 printable ASCII characters. Retrying with the same key and the same request replays the original response for 24 hours. See Idempotency.
schema:
type: string
minLength: 1
maxLength: 256
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`.'