Discover contractors
curl --request POST \
--url https://api.sortx.co.uk/contractor-discovery/search \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"trade": "<string>",
"postcode": "<string>"
}
'const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({trade: '<string>', postcode: '<string>'})
};
fetch('https://api.sortx.co.uk/contractor-discovery/search', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.sortx.co.uk/contractor-discovery/search"
payload = {
"trade": "<string>",
"postcode": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"provider": "<string>",
"attribution": "<string>",
"configured": true,
"note": "<string>",
"trade": "<string>",
"postcode": "<string>",
"results": [
{
"externalId": "<string>",
"name": "<string>",
"address": "<string>",
"postcode": "<string>",
"town": "<string>",
"phone": "<string>",
"website": "<string>",
"providerUrl": "<string>",
"existing": {
"contactId": "<string>",
"status": "<string>"
},
"sameName": {
"contactId": "<string>",
"name": "<string>"
}
}
]
}{
"_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
Discover contractors
Find local businesses for a trade near a postcode (nothing is stored or contacted)
POST
/
contractor-discovery
/
search
Discover contractors
curl --request POST \
--url https://api.sortx.co.uk/contractor-discovery/search \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"trade": "<string>",
"postcode": "<string>"
}
'const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({trade: '<string>', postcode: '<string>'})
};
fetch('https://api.sortx.co.uk/contractor-discovery/search', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.sortx.co.uk/contractor-discovery/search"
payload = {
"trade": "<string>",
"postcode": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"provider": "<string>",
"attribution": "<string>",
"configured": true,
"note": "<string>",
"trade": "<string>",
"postcode": "<string>",
"results": [
{
"externalId": "<string>",
"name": "<string>",
"address": "<string>",
"postcode": "<string>",
"town": "<string>",
"phone": "<string>",
"website": "<string>",
"providerUrl": "<string>",
"existing": {
"contactId": "<string>",
"status": "<string>"
},
"sameName": {
"contactId": "<string>",
"name": "<string>"
}
}
]
}{
"_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.