Jobs

BigChange jobs, constraints, stock, groups, and types. Auth: X-API-Key header. Base: https://api.vh3connect.io/api:YdihQNr3.

Shared parameters

Param	Type	Description
`pageNumber`	integer	Page index (1-based)
`pageSize`	integer	Items per page (default 100, max 1000)
`sortBy`	string	Sort field (endpoint-specific)
`direction`	enum	`ascending` or `descending`

Date filters (list)

POST /jobs/list requires createdAtFrom and createdAtTo (job creation time, ISO 8601 UTC). The span between them must not exceed 12 months. See overview.

Jobs

Job lifecycle.

`GET` `/jobs/job`

Get job.

curl -G "https://api.vh3connect.io/api:YdihQNr3/jobs/job" \
  -H "X-API-Key: your-api-key" \
  --data-urlencode "jobId=12345"

`POST` `/jobs/create`

Create job.

curl -X POST "https://api.vh3connect.io/api:YdihQNr3/jobs/create" \
  -H "X-API-Key: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "typeId": 42,
    "contactId": 12345,
    "description": "Blocked toilet"
  }'

`POST` `/jobs/edit`

Update job.

curl -X POST "https://api.vh3connect.io/api:YdihQNr3/jobs/edit" \
  -H "X-API-Key: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "jobId": 12345,
    "description": "Updated description"
  }'

`POST` `/jobs/list`

List jobs. createdAtFrom and createdAtTo are required. Max 12 months between them. Request body (key fields):

Field	Type	Required	Description
`createdAtFrom`	string	Yes	Jobs created on or after (ISO 8601 UTC)
`createdAtTo`	string	Yes	Jobs created on or before (ISO 8601 UTC)
`pageNumber`	integer	No	Page index
`pageSize`	integer	No	Items per page
`direction`	enum	No	`ascending` or `descending`
`contactId`	string	No	Filter by contact IDs (comma-separated)
`resourceId`	string	No	Filter by engineer IDs
`status`	string	No	Filter by job status

curl -X POST "https://api.vh3connect.io/api:YdihQNr3/jobs/list" \
  -H "X-API-Key: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "pageNumber": 1,
    "pageSize": 20,
    "createdAtFrom": "2026-01-01T00:00:00Z",
    "createdAtTo": "2026-03-31T23:59:59Z",
    "direction": "descending"
  }'

`POST` `/jobs/cancel`

Cancel job.

curl -X POST "https://api.vh3connect.io/api:YdihQNr3/jobs/cancel" \
  -H "X-API-Key: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "jobId": 12345,
    "reason": "Customer cancelled"
  }'

`POST` `/jobs/start`

Start job.

curl -X POST "https://api.vh3connect.io/api:YdihQNr3/jobs/start" \
  -H "X-API-Key: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "jobId": 12345,
    "comment": "On site"
  }'

`POST` `/jobs/result`

Set result. Enum values:

status: completedOk, completedWithIssues

curl -X POST "https://api.vh3connect.io/api:YdihQNr3/jobs/result" \
  -H "X-API-Key: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "jobId": 12345,
    "status": "completedOk",
    "result": "Job complete"
  }'

`POST` `/jobs/scheduling`

Schedule job.

curl -X POST "https://api.vh3connect.io/api:YdihQNr3/jobs/scheduling" \
  -H "X-API-Key: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "jobId": 12345,
    "resourceId": 100,
    "vehicleId": 50,
    "plannedStartAt": "2026-04-20T09:00:00Z"
  }'

`POST` `/jobs/scheduling/suggestions`

Candidate slots for resources or vehicles. Each item includes the resource or vehicle, startAt, extra distance, extra driving time, estimated cost, and skills. fromDate and toDate are required UTC timestamps. The window is at most seven days. A longer window returns BigChange’s 422, with BigChange’s validation body. A window from 13 October to 16 October returned slots on the 13th, 14th, and 15th only, so a toDate at midnight leaves out the day it names. The end is not an exact bound within a day: on DSSL a toDate of 08:05 and one of 08:04:59 both returned slots up to 08:20, so BigChange appears to keep the rest of the slot block that toDate falls in. Slots start in working hours, so no slot starts at midnight and the boundary itself cannot be seen on that tenant. latitude and longitude are required when jobId is absent. They have no default. Omitting both without a jobId returns BigChange’s 400. When jobId is sent, coordinates may be omitted and BigChange uses that job’s site. averageDurationMinutes, successRatePercent, and punctualityPercent are filled when jobId is sent and BigChange has history for that job type. A coordinates-only request leaves those three null. when is anytime, morning, afternoon, or custom. For custom, whenFrom and whenTo are the tenant’s local clock as HH:mm. startAt on each slot is UTC. resourceId, resourceGroupId, vehicleId, and vehicleGroupId each restrict to a single id; if you send several, only the first takes effect. To cover more, send one request per id. skillIds and attributeIds take up to 50 ids, and a slot must match all of them. The items array stays in BigChange’s order. This call leaves the job unassigned. Apply a chosen slot with POST /jobs/scheduling. Enum values:

schedulingType: resources, vehicles
when: anytime, morning, afternoon, custom

curl -X POST "https://api.vh3connect.io/api:YdihQNr3/jobs/scheduling/suggestions" \
  -H "X-API-Key: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "schedulingType": "resources",
    "fromDate": "2026-11-02T00:00:00Z",
    "toDate": "2026-11-08T00:00:00Z",
    "latitude": 51.5,
    "longitude": -0.12,
    "when": "custom",
    "whenFrom": "09:00",
    "whenTo": "11:00",
    "resourceId": [
      100
    ]
  }'

`POST` `/jobs/status/history`

Status history.

curl -X POST "https://api.vh3connect.io/api:YdihQNr3/jobs/status/history" \
  -H "X-API-Key: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "jobId": 12345,
    "pageNumber": 1,
    "pageSize": 50
  }'

Job constraints

Scheduling constraints.

`POST` `/jobs/constraints/create`

Create constraint.

curl -X POST "https://api.vh3connect.io/api:YdihQNr3/jobs/constraints/create" \
  -H "X-API-Key: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "jobId": 12345
  }'

`POST` `/jobs/constraints/delete`

Delete constraint.

curl -X POST "https://api.vh3connect.io/api:YdihQNr3/jobs/constraints/delete" \
  -H "X-API-Key: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "jobId": 12345,
    "constraintId": 1
  }'

`POST` `/jobs/constraints/list`

List constraints.

curl -X POST "https://api.vh3connect.io/api:YdihQNr3/jobs/constraints/list" \
  -H "X-API-Key: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "jobId": 12345,
    "pageNumber": 1,
    "pageSize": 20
  }'

Job stock

Parts on jobs.

`POST` `/jobs/stock/create`

Add stock line.

curl -X POST "https://api.vh3connect.io/api:YdihQNr3/jobs/stock/create" \
  -H "X-API-Key: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "jobId": 12345,
    "stockDetailsId": 10,
    "quantityPlanned": 1
  }'

`POST` `/jobs/stock/delete`

Remove stock line.

curl -X POST "https://api.vh3connect.io/api:YdihQNr3/jobs/stock/delete" \
  -H "X-API-Key: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "jobId": 12345,
    "jobStockId": 5
  }'

`POST` `/jobs/stock/get`

Get stock line.

curl -X POST "https://api.vh3connect.io/api:YdihQNr3/jobs/stock/get" \
  -H "X-API-Key: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "jobId": 12345,
    "jobStockId": 5
  }'

`POST` `/jobs/stock/list`

List stock lines.

curl -X POST "https://api.vh3connect.io/api:YdihQNr3/jobs/stock/list" \
  -H "X-API-Key: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "jobId": 12345,
    "pageNumber": 1,
    "pageSize": 20
  }'

Job groups

Multi-job programmes.

`POST` `/job_groups/create`

Create group.

curl -X POST "https://api.vh3connect.io/api:YdihQNr3/job_groups/create" \
  -H "X-API-Key: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Refurb phase 1"
  }'

`POST` `/job_groups/edit`

Update group.

curl -X POST "https://api.vh3connect.io/api:YdihQNr3/job_groups/edit" \
  -H "X-API-Key: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "jobGroupId": 10,
    "name": "Refurb phase 1"
  }'

`POST` `/job_groups/job_group`

Get group.

curl -X POST "https://api.vh3connect.io/api:YdihQNr3/job_groups/job_group" \
  -H "X-API-Key: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "jobGroupId": 10
  }'

`POST` `/job_groups/list`

List groups.

curl -X POST "https://api.vh3connect.io/api:YdihQNr3/job_groups/list" \
  -H "X-API-Key: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "pageNumber": 1,
    "pageSize": 20
  }'

`POST` `/job_groups/status_history`

Group status history.

curl -X POST "https://api.vh3connect.io/api:YdihQNr3/job_groups/status_history" \
  -H "X-API-Key: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "jobGroupId": 10,
    "pageNumber": 1,
    "pageSize": 20
  }'

`POST` `/job_groups/job_group_results_as_complete`

Mark complete.

curl -X POST "https://api.vh3connect.io/api:YdihQNr3/job_groups/job_group_results_as_complete" \
  -H "X-API-Key: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "jobGroupId": 10
  }'

`POST` `/job_groups/job_group_results_as_financially_complete`

Mark financially complete.

curl -X POST "https://api.vh3connect.io/api:YdihQNr3/job_groups/job_group_results_as_financially_complete" \
  -H "X-API-Key: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "jobGroupId": 10
  }'

Job types

Job type catalogue.

`POST` `/job_types/job_types`

Get type.

curl -X POST "https://api.vh3connect.io/api:YdihQNr3/job_types/job_types" \
  -H "X-API-Key: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "jobTypeId": 42
  }'

`POST` `/job_types/list`

List types.

curl -X POST "https://api.vh3connect.io/api:YdihQNr3/job_types/list" \
  -H "X-API-Key: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "pageNumber": 1,
    "pageSize": 100
  }'

VH3 AI Intelligence

BigChange API

Jobs

Jobs

Shared parameters

Date filters (list)

Jobs

`GET` `/jobs/job`

`POST` `/jobs/create`

`POST` `/jobs/edit`

`POST` `/jobs/list`

`POST` `/jobs/cancel`

`POST` `/jobs/start`

`POST` `/jobs/result`

`POST` `/jobs/scheduling`

`POST` `/jobs/scheduling/suggestions`

`POST` `/jobs/status/history`

Job constraints

`POST` `/jobs/constraints/create`

`POST` `/jobs/constraints/delete`

`POST` `/jobs/constraints/list`

Job stock

`POST` `/jobs/stock/create`

`POST` `/jobs/stock/delete`

`POST` `/jobs/stock/get`

`POST` `/jobs/stock/list`

Job groups

`POST` `/job_groups/create`

`POST` `/job_groups/edit`

`POST` `/job_groups/job_group`

`POST` `/job_groups/list`

`POST` `/job_groups/status_history`

`POST` `/job_groups/job_group_results_as_complete`

`POST` `/job_groups/job_group_results_as_financially_complete`

Job types

`POST` `/job_types/job_types`

`POST` `/job_types/list`

​Jobs

​Shared parameters

​Date filters (list)

​Jobs

​GET /jobs/job

​POST /jobs/create

​POST /jobs/edit

​POST /jobs/list

​POST /jobs/cancel

​POST /jobs/start

​POST /jobs/result

​POST /jobs/scheduling

​POST /jobs/scheduling/suggestions

​POST /jobs/status/history

​Job constraints

​POST /jobs/constraints/create

​POST /jobs/constraints/delete

​POST /jobs/constraints/list

​Job stock

​POST /jobs/stock/create

​POST /jobs/stock/delete

​POST /jobs/stock/get

​POST /jobs/stock/list

​Job groups

​POST /job_groups/create

​POST /job_groups/edit

​POST /job_groups/job_group

​POST /job_groups/list

​POST /job_groups/status_history

​POST /job_groups/job_group_results_as_complete

​POST /job_groups/job_group_results_as_financially_complete

​Job types

​POST /job_types/job_types

​POST /job_types/list

Jobs

Shared parameters

Date filters (list)

Jobs

`GET` `/jobs/job`

`POST` `/jobs/create`

`POST` `/jobs/edit`

`POST` `/jobs/list`

`POST` `/jobs/cancel`

`POST` `/jobs/start`

`POST` `/jobs/result`

`POST` `/jobs/scheduling`

`POST` `/jobs/scheduling/suggestions`

`POST` `/jobs/status/history`

Job constraints

`POST` `/jobs/constraints/create`

`POST` `/jobs/constraints/delete`

`POST` `/jobs/constraints/list`

Job stock

`POST` `/jobs/stock/create`

`POST` `/jobs/stock/delete`

`POST` `/jobs/stock/get`

`POST` `/jobs/stock/list`

Job groups

`POST` `/job_groups/create`

`POST` `/job_groups/edit`

`POST` `/job_groups/job_group`

`POST` `/job_groups/list`

`POST` `/job_groups/status_history`

`POST` `/job_groups/job_group_results_as_complete`

`POST` `/job_groups/job_group_results_as_financially_complete`

Job types

`POST` `/job_types/job_types`

`POST` `/job_types/list`