Get
curl --request GET \
--url https://api.sortx.co.uk/contractors/{contactId} \
--header 'x-api-key: <api-key>'const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.sortx.co.uk/contractors/{contactId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.sortx.co.uk/contractors/{contactId}"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"contactId": "<string>",
"name": "<string>",
"kind": "<string>",
"companyId": "<string>",
"companyName": "<string>",
"email": "<string>",
"mobile": "<string>",
"contactArchivedAt": "<string>",
"isContractor": true,
"status": "<string>",
"trades": [
"<string>"
],
"coverageAreas": [
"<string>"
],
"availability": "<string>",
"availableFrom": "<string>",
"availabilityNote": "<string>",
"preferenceRank": 123,
"ratesNotes": "<string>",
"notes": "<string>",
"deactivatedAt": "<string>",
"deactivationReason": "<string>",
"deactivatedByName": "<string>",
"revision": 123,
"updatedAt": "<string>",
"credentials": [
{
"id": "<string>",
"contactId": "<string>",
"kind": "<string>",
"name": "<string>",
"reference": "<string>",
"provider": "<string>",
"coverMinor": 123,
"currency": "<string>",
"issuedOn": "<string>",
"expiresOn": "<string>",
"documentId": "<string>",
"status": "<string>",
"supersededById": "<string>",
"endedAt": "<string>",
"endReason": "<string>",
"actorUserId": "<string>",
"actorName": "<string>",
"createdAt": "<string>"
}
],
"prospect": {
"provider": "<string>",
"externalId": "<string>",
"searchTrade": "<string>",
"searchPostcode": "<string>",
"addedByName": "<string>",
"addedAt": "<string>",
"invitedAt": "<string>",
"invitedVia": "<string>",
"invitedByName": "<string>",
"invitationCount": 123,
"activatedAt": "<string>",
"activatedByName": "<string>",
"checkNote": "<string>",
"dismissedAt": "<string>",
"dismissedByName": "<string>",
"dismissReason": "<string>"
},
"credentialHistory": [
{
"id": "<string>",
"contactId": "<string>",
"kind": "<string>",
"name": "<string>",
"reference": "<string>",
"provider": "<string>",
"coverMinor": 123,
"currency": "<string>",
"issuedOn": "<string>",
"expiresOn": "<string>",
"documentId": "<string>",
"status": "<string>",
"supersededById": "<string>",
"endedAt": "<string>",
"endReason": "<string>",
"actorUserId": "<string>",
"actorName": "<string>",
"createdAt": "<string>"
}
],
"overrides": [
{
"id": "<string>",
"contactId": "<string>",
"action": "<string>",
"subject": {
"kind": "<string>",
"id": "<string>"
},
"refusals": [
{
"code": "<string>",
"message": "<string>"
}
],
"warnings": [
{
"code": "<string>",
"message": "<string>"
}
],
"reason": "<string>",
"actorUserId": "<string>",
"actorName": "<string>",
"createdAt": "<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
Get
A contractor with its evidence history and the refusals people overrode
GET
/
contractors
/
{contactId}
Get
curl --request GET \
--url https://api.sortx.co.uk/contractors/{contactId} \
--header 'x-api-key: <api-key>'const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.sortx.co.uk/contractors/{contactId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.sortx.co.uk/contractors/{contactId}"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"contactId": "<string>",
"name": "<string>",
"kind": "<string>",
"companyId": "<string>",
"companyName": "<string>",
"email": "<string>",
"mobile": "<string>",
"contactArchivedAt": "<string>",
"isContractor": true,
"status": "<string>",
"trades": [
"<string>"
],
"coverageAreas": [
"<string>"
],
"availability": "<string>",
"availableFrom": "<string>",
"availabilityNote": "<string>",
"preferenceRank": 123,
"ratesNotes": "<string>",
"notes": "<string>",
"deactivatedAt": "<string>",
"deactivationReason": "<string>",
"deactivatedByName": "<string>",
"revision": 123,
"updatedAt": "<string>",
"credentials": [
{
"id": "<string>",
"contactId": "<string>",
"kind": "<string>",
"name": "<string>",
"reference": "<string>",
"provider": "<string>",
"coverMinor": 123,
"currency": "<string>",
"issuedOn": "<string>",
"expiresOn": "<string>",
"documentId": "<string>",
"status": "<string>",
"supersededById": "<string>",
"endedAt": "<string>",
"endReason": "<string>",
"actorUserId": "<string>",
"actorName": "<string>",
"createdAt": "<string>"
}
],
"prospect": {
"provider": "<string>",
"externalId": "<string>",
"searchTrade": "<string>",
"searchPostcode": "<string>",
"addedByName": "<string>",
"addedAt": "<string>",
"invitedAt": "<string>",
"invitedVia": "<string>",
"invitedByName": "<string>",
"invitationCount": 123,
"activatedAt": "<string>",
"activatedByName": "<string>",
"checkNote": "<string>",
"dismissedAt": "<string>",
"dismissedByName": "<string>",
"dismissReason": "<string>"
},
"credentialHistory": [
{
"id": "<string>",
"contactId": "<string>",
"kind": "<string>",
"name": "<string>",
"reference": "<string>",
"provider": "<string>",
"coverMinor": 123,
"currency": "<string>",
"issuedOn": "<string>",
"expiresOn": "<string>",
"documentId": "<string>",
"status": "<string>",
"supersededById": "<string>",
"endedAt": "<string>",
"endReason": "<string>",
"actorUserId": "<string>",
"actorName": "<string>",
"createdAt": "<string>"
}
],
"overrides": [
{
"id": "<string>",
"contactId": "<string>",
"action": "<string>",
"subject": {
"kind": "<string>",
"id": "<string>"
},
"refusals": [
{
"code": "<string>",
"message": "<string>"
}
],
"warnings": [
{
"code": "<string>",
"message": "<string>"
}
],
"reason": "<string>",
"actorUserId": "<string>",
"actorName": "<string>",
"createdAt": "<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.
Path Parameters
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