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-brands-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 Brands 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: Brands
description: Brand configuration (read-only)
paths:
/v1/brands:
get:
operationId: listBrands
summary: List brands
tags:
- Brands
description: 'List brands for your organisation (read-only).
- `?is_active=is.true` - Only active brands
- `?select=id,name,slug,is_active` - Field selection'
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:brands
x-postgrest-passthrough: true
responses:
'200':
description: Array of brands
content:
application/json:
schema:
description: Array of brands
type: object
properties:
data:
type: array
items:
type: object
properties:
id:
type: string
format: uuid
name:
type: string
description: Brand name
slug:
type: string
description: URL-safe identifier
description:
type:
- string
- 'null'
is_active:
type: boolean
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
verification_code_mode:
type:
- string
- 'null'
enum:
- T_DISABLED
- T_ENABLED
- null
description: Whether jobs under this brand carry a customer verification code
verification_code_format:
type:
- string
- 'null'
enum:
- T_WORD_PAIR
- T_ALPHANUMERIC
- T_PIN
- null
meta:
type: object
properties:
request_id:
type: string
timestamp:
type: string
format: date-time
/v1/brands/{brandId}/config:
get:
operationId: getBrandConfig
summary: Get brand configuration
tags:
- Brands
parameters:
- schema:
type: string
format: uuid
in: path
name: brandId
required: true
security:
- bearerAuth: []
x-required-scopes:
- read:brands
responses:
'200':
description: Default Response
content:
application/json:
schema:
type: object
required:
- data
- meta
properties:
data:
type: object
required:
- branding
- job_config
- preferences
properties:
branding:
type:
- object
- 'null'
description: Null when the brand has no branding settings saved
required:
- logo_url
- favicon_url
- primary_color
- secondary_color
- accent_color
- custom_domain
properties:
logo_url:
type:
- string
- 'null'
favicon_url:
type:
- string
- 'null'
primary_color:
type:
- string
- 'null'
description: 'Hex colour, #RRGGBB'
secondary_color:
type:
- string
- 'null'
description: 'Hex colour, #RRGGBB'
accent_color:
type:
- string
- 'null'
description: 'Hex colour, #RRGGBB'
custom_domain:
type:
- string
- 'null'
job_config:
type:
- object
- 'null'
description: Null when the brand has no job settings saved
required:
- job_number_format
- job_number_next
- auto_assign_enabled
properties:
job_number_format:
type:
- string
- 'null'
description: Pattern new job numbers follow, e.g. JOB{NUM:5}
job_number_next:
type:
- integer
- 'null'
description: The number the next job will take
auto_assign_enabled:
type:
- boolean
- 'null'
preferences:
type:
- object
- 'null'
description: Null when the brand has no preferences saved
required:
- timezone
- locale
- date_format
- time_format
- first_day_of_week
- business_hours_enabled
- business_hours
properties:
timezone:
type:
- string
- 'null'
description: IANA time zone name
locale:
type:
- string
- 'null'
date_format:
type:
- string
- 'null'
enum:
- MM/DD/YYYY
- DD/MM/YYYY
- YYYY-MM-DD
- null
time_format:
type:
- string
- 'null'
enum:
- 12h
- 24h
- null
first_day_of_week:
type:
- integer
- 'null'
minimum: 0
maximum: 6
description: 0 is Sunday
business_hours_enabled:
type:
- boolean
- 'null'
business_hours:
type:
- object
- 'null'
additionalProperties: true
description: Opening hours keyed by lowercase day name, each `{ start, end, enabled }` with times as HH:MM
meta:
type: object
required:
- request_id
- timestamp
properties:
request_id:
type: string
timestamp:
type: string
format: date-time
/v1/brands/{brandId}/terminology:
get:
operationId: getBrandTerminology
summary: Get brand terminology
tags:
- Brands
parameters:
- schema:
type: string
format: uuid
in: path
name: brandId
required: true
security:
- bearerAuth: []
x-required-scopes:
- read:brands
responses:
'200':
description: Default Response
content:
application/json:
schema:
type: object
required:
- data
- meta
properties:
data:
type: array
items:
type: object
required:
- term_key
- singular
- plural
- is_custom
properties:
term_key:
type: string
singular:
type: string
plural:
type:
- string
- 'null'
is_custom:
type: boolean
description: True when the brand has overridden the term, false when it is the default
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`.'