Directory
curl --request GET \
--url https://api.sortx.co.uk/contractor-directory \
--header 'x-api-key: <api-key>'const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.sortx.co.uk/contractor-directory', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.sortx.co.uk/contractor-directory"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"today": "<string>",
"kpis": {
"active": 123,
"trades": 123,
"compliant": 123,
"paused": 123,
"expiring30": 123,
"averageRating": 123,
"ratedJobs": 123
},
"allCount": 123,
"tabs": [
{
"tradeId": "<string>",
"label": "<string>",
"count": 123
}
],
"rows": [
{
"contactId": "<string>",
"name": "<string>",
"subline": "<string>",
"trades": [
"<string>"
],
"primaryTrade": "<string>",
"primaryTradeLabel": "<string>",
"areas": "<string>",
"jobs12mo": 123,
"rating": 123,
"compliance": {
"tone": "ok",
"label": "<string>",
"credentialId": "<string>"
},
"paused": true,
"preferred": 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>"
}contractors
Directory
The Directory board: active contractors with their trade, areas, jobs, rating and compliance, the KPIs and trade tabs
GET
/
contractor-directory
Directory
curl --request GET \
--url https://api.sortx.co.uk/contractor-directory \
--header 'x-api-key: <api-key>'const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.sortx.co.uk/contractor-directory', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.sortx.co.uk/contractor-directory"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"today": "<string>",
"kpis": {
"active": 123,
"trades": 123,
"compliant": 123,
"paused": 123,
"expiring30": 123,
"averageRating": 123,
"ratedJobs": 123
},
"allCount": 123,
"tabs": [
{
"tradeId": "<string>",
"label": "<string>",
"count": 123
}
],
"rows": [
{
"contactId": "<string>",
"name": "<string>",
"subline": "<string>",
"trades": [
"<string>"
],
"primaryTrade": "<string>",
"primaryTradeLabel": "<string>",
"areas": "<string>",
"jobs12mo": 123,
"rating": 123,
"compliance": {
"tone": "ok",
"label": "<string>",
"credentialId": "<string>"
},
"paused": true,
"preferred": 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>"
}