workwing-io Location History API
GPS traces and job segments (read-only)
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-location-history-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 Location History 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: Location History
description: GPS traces and job segments (read-only)
paths:
/v1/jobs/{jobId}/location-history:
get:
operationId: getJobLocationHistory
summary: Get GPS trace for a job assignment
tags:
- Location History
description: 'Returns timestamped lat/lng points recorded during a resource''s assignment to a job. This is the engineer''s live position, for your own team only. Do not show it to customers: for a customer-facing tracking page use GET /v1/jobs/{jobId}/tracking, which returns a rough location that is safe to share.'
parameters:
- schema:
type: string
format: uuid
pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
in: query
name: resource_id
required: true
- schema:
type: string
format: uuid
in: path
name: jobId
required: true
security:
- bearerAuth: []
x-required-scopes:
- read:jobs
responses:
'200':
description: Points in time order. Empty when the resource is not assigned to the job.
content:
application/json:
schema:
description: Points in time order. Empty when the resource is not assigned to the job.
type: object
required:
- data
- meta
properties:
data:
type: array
items:
type: object
required:
- latitude
- longitude
- accuracy
- recorded_at
properties:
latitude:
type: number
longitude:
type: number
accuracy:
type:
- number
- 'null'
description: Reported accuracy radius in metres
recorded_at:
type: string
format: date-time
meta:
type: object
required:
- request_id
- timestamp
- count
properties:
request_id:
type: string
timestamp:
type: string
format: date-time
count:
type: integer
description: Number of items in data
/v1/resources/{resourceId}/job-segments:
get:
operationId: listResourceJobSegments
summary: Get job assignment segments for a resource day
tags:
- Location History
description: Returns start/end times of job assignments with associated job info for a given date
parameters:
- schema:
type: string
pattern: ^\d{4}-\d{2}-\d{2}$
in: query
name: date
required: true
- schema:
type: string
format: uuid
in: path
name: resourceId
required: true
security:
- bearerAuth: []
x-required-scopes:
- read:resources
responses:
'200':
description: Assignment segments, earliest first
content:
application/json:
schema:
description: Assignment segments, earliest first
type: object
required:
- data
- meta
properties:
data:
type: array
items:
type: object
required:
- job_id
- job_number
- customer_name
- assignment_status
- segment_start
- segment_end
- job_latitude
- job_longitude
- job_address
properties:
job_id:
type: string
format: uuid
job_number:
type:
- string
- 'null'
customer_name:
type:
- string
- 'null'
assignment_status:
type: string
segment_start:
type: string
format: date-time
description: When the resource acknowledged the assignment, or was assigned if it never acknowledged
segment_end:
type: string
format: date-time
description: When the job was completed, or the time of the request if it is not complete
job_latitude:
type:
- number
- 'null'
job_longitude:
type:
- number
- 'null'
job_address:
type:
- string
- 'null'
meta:
type: object
required:
- request_id
- timestamp
- count
properties:
request_id:
type: string
timestamp:
type: string
format: date-time
count:
type: integer
description: Number of items in data
/v1/resources/{resourceId}/location-history:
get:
operationId: getResourceLocationHistory
summary: Get full day route for a resource
tags:
- Location History
description: 'Returns all timestamped lat/lng points recorded for a resource on a given date. This is the engineer''s live position, for your own team only. Do not show it to customers: for a customer-facing tracking page use GET /v1/jobs/{jobId}/tracking, which returns a rough location that is safe to share.'
parameters:
- schema:
type: string
pattern: ^\d{4}-\d{2}-\d{2}$
in: query
name: date
required: true
- schema:
type: string
format: uuid
in: path
name: resourceId
required: true
security:
- bearerAuth: []
x-required-scopes:
- read:resources
responses:
'200':
description: Points in time order
content:
application/json:
schema:
description: Points in time order
type: object
required:
- data
- meta
properties:
data:
type: array
items:
type: object
required:
- latitude
- longitude
- accuracy
- recorded_at
properties:
latitude:
type: number
longitude:
type: number
accuracy:
type:
- number
- 'null'
description: Reported accuracy radius in metres
recorded_at:
type: string
format: date-time
meta:
type: object
required:
- request_id
- timestamp
- count
properties:
request_id:
type: string
timestamp:
type: string
format: date-time
count:
type: integer
description: Number of items in data
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`.'