Create a new work order
curl --request POST \
--url https://api.ctrl-hub.com/v3/work-orders \
--header 'Content-Type: application/vnd.api+json' \
--header 'X-Session-Token: <api-key>' \
--data '
{
"data": {
"type": "work-orders",
"attributes": {
"name": "Infrastructure Installation Work Order",
"code": "WO001",
"description": "Install new infrastructure equipment",
"dates": {
"anticipated": {
"start": "2024-01-15T09:00:00Z",
"end": "2024-01-20T17:00:00Z"
}
},
"labels": [
{
"key": "Your label key",
"value": "Your label value"
}
]
},
"relationships": {
"organisation": {},
"scheme": {},
"template": {}
}
}
}
'import requests
url = "https://api.ctrl-hub.com/v3/work-orders"
payload = { "data": {
"type": "work-orders",
"attributes": {
"name": "Infrastructure Installation Work Order",
"code": "WO001",
"description": "Install new infrastructure equipment",
"dates": { "anticipated": {
"start": "2024-01-15T09:00:00Z",
"end": "2024-01-20T17:00:00Z"
} },
"labels": [
{
"key": "Your label key",
"value": "Your label value"
}
]
},
"relationships": {
"organisation": {},
"scheme": {},
"template": {}
}
} }
headers = {
"X-Session-Token": "<api-key>",
"Content-Type": "application/vnd.api+json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Session-Token': '<api-key>', 'Content-Type': 'application/vnd.api+json'},
body: JSON.stringify({
data: {
type: 'work-orders',
attributes: {
name: 'Infrastructure Installation Work Order',
code: 'WO001',
description: 'Install new infrastructure equipment',
dates: {anticipated: {start: '2024-01-15T09:00:00Z', end: '2024-01-20T17:00:00Z'}},
labels: [{key: 'Your label key', value: 'Your label value'}]
},
relationships: {organisation: {}, scheme: {}, template: {}}
}
})
};
fetch('https://api.ctrl-hub.com/v3/work-orders', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.ctrl-hub.com/v3/work-orders",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'data' => [
'type' => 'work-orders',
'attributes' => [
'name' => 'Infrastructure Installation Work Order',
'code' => 'WO001',
'description' => 'Install new infrastructure equipment',
'dates' => [
'anticipated' => [
'start' => '2024-01-15T09:00:00Z',
'end' => '2024-01-20T17:00:00Z'
]
],
'labels' => [
[
'key' => 'Your label key',
'value' => 'Your label value'
]
]
],
'relationships' => [
'organisation' => [
],
'scheme' => [
],
'template' => [
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/vnd.api+json",
"X-Session-Token: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.ctrl-hub.com/v3/work-orders"
payload := strings.NewReader("{\n \"data\": {\n \"type\": \"work-orders\",\n \"attributes\": {\n \"name\": \"Infrastructure Installation Work Order\",\n \"code\": \"WO001\",\n \"description\": \"Install new infrastructure equipment\",\n \"dates\": {\n \"anticipated\": {\n \"start\": \"2024-01-15T09:00:00Z\",\n \"end\": \"2024-01-20T17:00:00Z\"\n }\n },\n \"labels\": [\n {\n \"key\": \"Your label key\",\n \"value\": \"Your label value\"\n }\n ]\n },\n \"relationships\": {\n \"organisation\": {},\n \"scheme\": {},\n \"template\": {}\n }\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Session-Token", "<api-key>")
req.Header.Add("Content-Type", "application/vnd.api+json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.ctrl-hub.com/v3/work-orders")
.header("X-Session-Token", "<api-key>")
.header("Content-Type", "application/vnd.api+json")
.body("{\n \"data\": {\n \"type\": \"work-orders\",\n \"attributes\": {\n \"name\": \"Infrastructure Installation Work Order\",\n \"code\": \"WO001\",\n \"description\": \"Install new infrastructure equipment\",\n \"dates\": {\n \"anticipated\": {\n \"start\": \"2024-01-15T09:00:00Z\",\n \"end\": \"2024-01-20T17:00:00Z\"\n }\n },\n \"labels\": [\n {\n \"key\": \"Your label key\",\n \"value\": \"Your label value\"\n }\n ]\n },\n \"relationships\": {\n \"organisation\": {},\n \"scheme\": {},\n \"template\": {}\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ctrl-hub.com/v3/work-orders")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Session-Token"] = '<api-key>'
request["Content-Type"] = 'application/vnd.api+json'
request.body = "{\n \"data\": {\n \"type\": \"work-orders\",\n \"attributes\": {\n \"name\": \"Infrastructure Installation Work Order\",\n \"code\": \"WO001\",\n \"description\": \"Install new infrastructure equipment\",\n \"dates\": {\n \"anticipated\": {\n \"start\": \"2024-01-15T09:00:00Z\",\n \"end\": \"2024-01-20T17:00:00Z\"\n }\n },\n \"labels\": [\n {\n \"key\": \"Your label key\",\n \"value\": \"Your label value\"\n }\n ]\n },\n \"relationships\": {\n \"organisation\": {},\n \"scheme\": {},\n \"template\": {}\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "fb082ee5-b678-4451-b02b-8269aaf262a3",
"type": "work-orders",
"attributes": {
"name": "Infrastructure Maintenance Work Order",
"status": "in_planning",
"code": "WO-2025-001",
"description": "Routine maintenance and inspection of electrical infrastructure",
"dates": {
"anticipated": {
"start": "2025-08-01T09:00:00Z",
"end": "2025-08-15T17:00:00Z"
}
},
"labels": [
{
"key": "Your label key",
"value": "Your label value"
}
]
},
"meta": {
"created_at": "2025-05-06T18:37:12Z",
"updated_at": "2025-05-07T21:12:46Z",
"modified_at": "2025-05-07T21:12:46Z",
"dates": {
"scheduled": {
"start": "2025-08-01T09:00:00Z",
"end": "2025-08-15T17:00:00Z"
}
},
"counts": {
"operations": 1,
"streets": 1,
"properties": 1,
"locations": 1
},
"completeness": {
"percentage": {
"completed": 25,
"aborted": 0,
"unknown": 75,
"cancelled": 0
},
"counts": {
"completed": 1,
"aborted": 0,
"unknown": 3,
"cancelled": 0
},
"statuses": {
"counts": {
"done": 3,
"in_progress": 1,
"todo": 1
},
"percentages": {
"done": 60,
"in_progress": 20,
"todo": 20
}
},
"done_reasons": {
"counts": {
"aborted": 1,
"cancelled": 2,
"completed": 2
},
"percentages": {
"aborted": 20,
"cancelled": 40,
"completed": 40
}
}
}
},
"relationships": {
"organisation": {
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "organisations"
}
},
"scheme": {
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "schemes"
}
},
"operations": {
"data": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "operations"
}
]
},
"assignees": {
"data": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "users"
}
]
},
"teams": {
"data": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "teams"
}
]
},
"template": {
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "work-order-templates"
}
},
"site_managers": {
"data": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "users"
}
]
},
"folder": {
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "folders"
}
},
"locations": {
"data": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "locations"
}
]
}
}
},
"jsonapi": {
"version": "1.0"
},
"included": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "appointments",
"attributes": {
"start_time": "2023-11-07T05:31:56Z",
"end_time": "2023-11-07T05:31:56Z",
"medical_dependency": true,
"on_ecr": true,
"animals": true,
"notes": "<string>",
"on_ecr_notes": "<string>",
"status": "scheduled",
"cancelled_at": "2023-11-07T05:31:56Z",
"cancelled_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"cancellation_reason": "<string>"
},
"meta": {
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"modified_at": "2023-11-07T05:31:56Z"
},
"relationships": {
"author": {
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "authors"
}
},
"interaction": {
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "customer-interactions"
}
},
"operation": {
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "operations"
}
},
"time_band": {
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "time-bands"
}
},
"organisation": {
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "organisations"
}
}
}
}
]
}{
"id": "98ca4a78-b66f-4234-9719-aaf832ee6669",
"status": "400",
"title": "A validation error was encountered",
"source": {
"parameter": "include"
},
"meta": {
"resource": "wrong_value"
}
}{
"id": "05fc9c8d-73b9-4697-9337-57f7a567a48f",
"status": "401",
"title": "You are not authorised to access this resource",
"detail": "In order to access this resource, you need the 'admin' role.",
"code": "AUTH.001"
}{
"id": "8e2f9a34-b5c6-4d7e-9f8a-2b3c4d5e6f7g",
"status": "409",
"title": "Conflict",
"detail": "The request conflicts with the current state of the resource.",
"code": "CONFLICT.001"
}{
"id": "fe9d9a69-f0a7-4fdc-bb2c-176027f316c5",
"status": "500",
"title": "Internal Server Error",
"detail": "An unexpected error occurred on the server."
}Work Orders
Create a work order
Create a new work order.
POST
/
v3
/
work-orders
Create a new work order
curl --request POST \
--url https://api.ctrl-hub.com/v3/work-orders \
--header 'Content-Type: application/vnd.api+json' \
--header 'X-Session-Token: <api-key>' \
--data '
{
"data": {
"type": "work-orders",
"attributes": {
"name": "Infrastructure Installation Work Order",
"code": "WO001",
"description": "Install new infrastructure equipment",
"dates": {
"anticipated": {
"start": "2024-01-15T09:00:00Z",
"end": "2024-01-20T17:00:00Z"
}
},
"labels": [
{
"key": "Your label key",
"value": "Your label value"
}
]
},
"relationships": {
"organisation": {},
"scheme": {},
"template": {}
}
}
}
'import requests
url = "https://api.ctrl-hub.com/v3/work-orders"
payload = { "data": {
"type": "work-orders",
"attributes": {
"name": "Infrastructure Installation Work Order",
"code": "WO001",
"description": "Install new infrastructure equipment",
"dates": { "anticipated": {
"start": "2024-01-15T09:00:00Z",
"end": "2024-01-20T17:00:00Z"
} },
"labels": [
{
"key": "Your label key",
"value": "Your label value"
}
]
},
"relationships": {
"organisation": {},
"scheme": {},
"template": {}
}
} }
headers = {
"X-Session-Token": "<api-key>",
"Content-Type": "application/vnd.api+json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Session-Token': '<api-key>', 'Content-Type': 'application/vnd.api+json'},
body: JSON.stringify({
data: {
type: 'work-orders',
attributes: {
name: 'Infrastructure Installation Work Order',
code: 'WO001',
description: 'Install new infrastructure equipment',
dates: {anticipated: {start: '2024-01-15T09:00:00Z', end: '2024-01-20T17:00:00Z'}},
labels: [{key: 'Your label key', value: 'Your label value'}]
},
relationships: {organisation: {}, scheme: {}, template: {}}
}
})
};
fetch('https://api.ctrl-hub.com/v3/work-orders', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.ctrl-hub.com/v3/work-orders",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'data' => [
'type' => 'work-orders',
'attributes' => [
'name' => 'Infrastructure Installation Work Order',
'code' => 'WO001',
'description' => 'Install new infrastructure equipment',
'dates' => [
'anticipated' => [
'start' => '2024-01-15T09:00:00Z',
'end' => '2024-01-20T17:00:00Z'
]
],
'labels' => [
[
'key' => 'Your label key',
'value' => 'Your label value'
]
]
],
'relationships' => [
'organisation' => [
],
'scheme' => [
],
'template' => [
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/vnd.api+json",
"X-Session-Token: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.ctrl-hub.com/v3/work-orders"
payload := strings.NewReader("{\n \"data\": {\n \"type\": \"work-orders\",\n \"attributes\": {\n \"name\": \"Infrastructure Installation Work Order\",\n \"code\": \"WO001\",\n \"description\": \"Install new infrastructure equipment\",\n \"dates\": {\n \"anticipated\": {\n \"start\": \"2024-01-15T09:00:00Z\",\n \"end\": \"2024-01-20T17:00:00Z\"\n }\n },\n \"labels\": [\n {\n \"key\": \"Your label key\",\n \"value\": \"Your label value\"\n }\n ]\n },\n \"relationships\": {\n \"organisation\": {},\n \"scheme\": {},\n \"template\": {}\n }\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Session-Token", "<api-key>")
req.Header.Add("Content-Type", "application/vnd.api+json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.ctrl-hub.com/v3/work-orders")
.header("X-Session-Token", "<api-key>")
.header("Content-Type", "application/vnd.api+json")
.body("{\n \"data\": {\n \"type\": \"work-orders\",\n \"attributes\": {\n \"name\": \"Infrastructure Installation Work Order\",\n \"code\": \"WO001\",\n \"description\": \"Install new infrastructure equipment\",\n \"dates\": {\n \"anticipated\": {\n \"start\": \"2024-01-15T09:00:00Z\",\n \"end\": \"2024-01-20T17:00:00Z\"\n }\n },\n \"labels\": [\n {\n \"key\": \"Your label key\",\n \"value\": \"Your label value\"\n }\n ]\n },\n \"relationships\": {\n \"organisation\": {},\n \"scheme\": {},\n \"template\": {}\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ctrl-hub.com/v3/work-orders")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Session-Token"] = '<api-key>'
request["Content-Type"] = 'application/vnd.api+json'
request.body = "{\n \"data\": {\n \"type\": \"work-orders\",\n \"attributes\": {\n \"name\": \"Infrastructure Installation Work Order\",\n \"code\": \"WO001\",\n \"description\": \"Install new infrastructure equipment\",\n \"dates\": {\n \"anticipated\": {\n \"start\": \"2024-01-15T09:00:00Z\",\n \"end\": \"2024-01-20T17:00:00Z\"\n }\n },\n \"labels\": [\n {\n \"key\": \"Your label key\",\n \"value\": \"Your label value\"\n }\n ]\n },\n \"relationships\": {\n \"organisation\": {},\n \"scheme\": {},\n \"template\": {}\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "fb082ee5-b678-4451-b02b-8269aaf262a3",
"type": "work-orders",
"attributes": {
"name": "Infrastructure Maintenance Work Order",
"status": "in_planning",
"code": "WO-2025-001",
"description": "Routine maintenance and inspection of electrical infrastructure",
"dates": {
"anticipated": {
"start": "2025-08-01T09:00:00Z",
"end": "2025-08-15T17:00:00Z"
}
},
"labels": [
{
"key": "Your label key",
"value": "Your label value"
}
]
},
"meta": {
"created_at": "2025-05-06T18:37:12Z",
"updated_at": "2025-05-07T21:12:46Z",
"modified_at": "2025-05-07T21:12:46Z",
"dates": {
"scheduled": {
"start": "2025-08-01T09:00:00Z",
"end": "2025-08-15T17:00:00Z"
}
},
"counts": {
"operations": 1,
"streets": 1,
"properties": 1,
"locations": 1
},
"completeness": {
"percentage": {
"completed": 25,
"aborted": 0,
"unknown": 75,
"cancelled": 0
},
"counts": {
"completed": 1,
"aborted": 0,
"unknown": 3,
"cancelled": 0
},
"statuses": {
"counts": {
"done": 3,
"in_progress": 1,
"todo": 1
},
"percentages": {
"done": 60,
"in_progress": 20,
"todo": 20
}
},
"done_reasons": {
"counts": {
"aborted": 1,
"cancelled": 2,
"completed": 2
},
"percentages": {
"aborted": 20,
"cancelled": 40,
"completed": 40
}
}
}
},
"relationships": {
"organisation": {
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "organisations"
}
},
"scheme": {
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "schemes"
}
},
"operations": {
"data": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "operations"
}
]
},
"assignees": {
"data": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "users"
}
]
},
"teams": {
"data": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "teams"
}
]
},
"template": {
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "work-order-templates"
}
},
"site_managers": {
"data": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "users"
}
]
},
"folder": {
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "folders"
}
},
"locations": {
"data": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "locations"
}
]
}
}
},
"jsonapi": {
"version": "1.0"
},
"included": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "appointments",
"attributes": {
"start_time": "2023-11-07T05:31:56Z",
"end_time": "2023-11-07T05:31:56Z",
"medical_dependency": true,
"on_ecr": true,
"animals": true,
"notes": "<string>",
"on_ecr_notes": "<string>",
"status": "scheduled",
"cancelled_at": "2023-11-07T05:31:56Z",
"cancelled_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"cancellation_reason": "<string>"
},
"meta": {
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"modified_at": "2023-11-07T05:31:56Z"
},
"relationships": {
"author": {
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "authors"
}
},
"interaction": {
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "customer-interactions"
}
},
"operation": {
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "operations"
}
},
"time_band": {
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "time-bands"
}
},
"organisation": {
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "organisations"
}
}
}
}
]
}{
"id": "98ca4a78-b66f-4234-9719-aaf832ee6669",
"status": "400",
"title": "A validation error was encountered",
"source": {
"parameter": "include"
},
"meta": {
"resource": "wrong_value"
}
}{
"id": "05fc9c8d-73b9-4697-9337-57f7a567a48f",
"status": "401",
"title": "You are not authorised to access this resource",
"detail": "In order to access this resource, you need the 'admin' role.",
"code": "AUTH.001"
}{
"id": "8e2f9a34-b5c6-4d7e-9f8a-2b3c4d5e6f7g",
"status": "409",
"title": "Conflict",
"detail": "The request conflicts with the current state of the resource.",
"code": "CONFLICT.001"
}{
"id": "fe9d9a69-f0a7-4fdc-bb2c-176027f316c5",
"status": "500",
"title": "Internal Server Error",
"detail": "An unexpected error occurred on the server."
}Authorizations
SessionOAuth2Cookie
Session token for authentication.
Body
application/vnd.api+json
The work order to create.
Show child attributes
Show child attributes
Response
An individual work order.
JSON API response object
A work order
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Related resources that can be included when a work order is returned
An appointment
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
- Option 6
- Option 7
- Option 8
- Option 9
- Option 10
- Option 11
Show child attributes
Show child attributes