Get
curl --request GET \
--url https://api.sortx.co.uk/operational-catalogues \
--header 'x-api-key: <api-key>'const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.sortx.co.uk/operational-catalogues', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.sortx.co.uk/operational-catalogues"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"revision": 123,
"canManage": true,
"staff": [
{
"id": "<string>",
"userId": "<string>",
"displayName": "<string>",
"email": "<string>",
"jobTitle": "<string>",
"workPhone": "<string>",
"branchId": "<string>",
"brandId": "<string>",
"timezone": "<string>",
"active": true,
"loginRole": "<string>",
"banned": true,
"eligible": true,
"ineligibleReason": "<string>"
}
],
"teams": [
{
"id": "<string>",
"name": "<string>",
"purpose": "<string>",
"branchId": "<string>",
"leadStaffId": "<string>",
"memberIds": [
"<string>"
],
"active": true
}
],
"taskTypes": [
{
"id": "<string>",
"name": "<string>",
"description": "<string>",
"colour": "<string>",
"defaultPriority": "<string>",
"defaultDueDays": 123,
"active": true
}
],
"matchingAreas": [
{
"id": "<string>",
"name": "<string>",
"towns": [
"<string>"
],
"postcodes": [
"<string>"
],
"notes": "<string>",
"active": true
}
],
"serviceTemplates": [
{
"id": "<string>",
"name": "<string>",
"description": "<string>",
"category": "<string>",
"assetClass": "<string>",
"eventType": "<string>",
"statutory": true,
"recurrenceInterval": 123,
"recurrenceUnit": "<string>",
"instructionLeadDays": 123,
"instructions": "<string>",
"defaultCostCodeId": "<string>",
"active": true
}
],
"costCodes": [
{
"id": "<string>",
"code": "<string>",
"name": "<string>",
"description": "<string>",
"scope": {
"kind": "<string>",
"branchId": "<string>",
"refId": "<string>",
"label": "<string>"
},
"contractorPayableMinor": 123,
"agencyReceivableMinor": 123,
"currency": "<string>",
"active": true
}
]
}{
"_tag": "TenantCreateRejected",
"reason": "<string>",
"field": "<string>"
}{
"_tag": "Unauthenticated"
}{
"_tag": "TenantSuspended",
"tenantId": "<string>",
"reason": "<string>"
}{
"_tag": "EntitlementMissing",
"tenantId": "<string>",
"moduleId": "<string>"
}{
"_tag": "TenantNotFound",
"slug": "<string>"
}{
"_tag": "WebhookDuplicate",
"integration": "<string>",
"externalId": "<string>"
}{
"_tag": "RateLimited",
"key": "<string>",
"retryAfterSeconds": 123,
"message": "<string>"
}{
"_tag": "IntegrationUnavailable",
"integration": "<string>",
"detail": "<string>"
}operational-catalogues
Get
Read the workspace’s staff records and operational catalogues
GET
/
operational-catalogues
Get
curl --request GET \
--url https://api.sortx.co.uk/operational-catalogues \
--header 'x-api-key: <api-key>'const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.sortx.co.uk/operational-catalogues', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.sortx.co.uk/operational-catalogues"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"revision": 123,
"canManage": true,
"staff": [
{
"id": "<string>",
"userId": "<string>",
"displayName": "<string>",
"email": "<string>",
"jobTitle": "<string>",
"workPhone": "<string>",
"branchId": "<string>",
"brandId": "<string>",
"timezone": "<string>",
"active": true,
"loginRole": "<string>",
"banned": true,
"eligible": true,
"ineligibleReason": "<string>"
}
],
"teams": [
{
"id": "<string>",
"name": "<string>",
"purpose": "<string>",
"branchId": "<string>",
"leadStaffId": "<string>",
"memberIds": [
"<string>"
],
"active": true
}
],
"taskTypes": [
{
"id": "<string>",
"name": "<string>",
"description": "<string>",
"colour": "<string>",
"defaultPriority": "<string>",
"defaultDueDays": 123,
"active": true
}
],
"matchingAreas": [
{
"id": "<string>",
"name": "<string>",
"towns": [
"<string>"
],
"postcodes": [
"<string>"
],
"notes": "<string>",
"active": true
}
],
"serviceTemplates": [
{
"id": "<string>",
"name": "<string>",
"description": "<string>",
"category": "<string>",
"assetClass": "<string>",
"eventType": "<string>",
"statutory": true,
"recurrenceInterval": 123,
"recurrenceUnit": "<string>",
"instructionLeadDays": 123,
"instructions": "<string>",
"defaultCostCodeId": "<string>",
"active": true
}
],
"costCodes": [
{
"id": "<string>",
"code": "<string>",
"name": "<string>",
"description": "<string>",
"scope": {
"kind": "<string>",
"branchId": "<string>",
"refId": "<string>",
"label": "<string>"
},
"contractorPayableMinor": 123,
"agencyReceivableMinor": 123,
"currency": "<string>",
"active": true
}
]
}{
"_tag": "TenantCreateRejected",
"reason": "<string>",
"field": "<string>"
}{
"_tag": "Unauthenticated"
}{
"_tag": "TenantSuspended",
"tenantId": "<string>",
"reason": "<string>"
}{
"_tag": "EntitlementMissing",
"tenantId": "<string>",
"moduleId": "<string>"
}{
"_tag": "TenantNotFound",
"slug": "<string>"
}{
"_tag": "WebhookDuplicate",
"integration": "<string>",
"externalId": "<string>"
}{
"_tag": "RateLimited",
"key": "<string>",
"retryAfterSeconds": 123,
"message": "<string>"
}{
"_tag": "IntegrationUnavailable",
"integration": "<string>",
"detail": "<string>"
}Authorizations
A workspace API key (Settings → API keys), scoped to <group>:read / <group>:write.
Response
Success
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes