Create asset
curl --request POST \
--url https://api.sortx.co.uk/assets \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"requestId": "<string>",
"name": "<string>",
"category": "<string>",
"reference": "<string>",
"propertyId": "<string>",
"unitId": "<string>",
"blockId": "<string>",
"location": "<string>",
"manufacturer": "<string>",
"model": "<string>",
"serialNumber": "<string>",
"quantity": 123,
"installedOn": "<string>",
"warrantyExpiresOn": "<string>",
"servicingContactId": "<string>",
"servicingCompanyId": "<string>",
"warrantyProviderContactId": "<string>",
"warrantyProviderCompanyId": "<string>",
"notes": "<string>"
}
'const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
requestId: '<string>',
name: '<string>',
category: '<string>',
reference: '<string>',
propertyId: '<string>',
unitId: '<string>',
blockId: '<string>',
location: '<string>',
manufacturer: '<string>',
model: '<string>',
serialNumber: '<string>',
quantity: 123,
installedOn: '<string>',
warrantyExpiresOn: '<string>',
servicingContactId: '<string>',
servicingCompanyId: '<string>',
warrantyProviderContactId: '<string>',
warrantyProviderCompanyId: '<string>',
notes: '<string>'
})
};
fetch('https://api.sortx.co.uk/assets', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.sortx.co.uk/assets"
payload = {
"requestId": "<string>",
"name": "<string>",
"category": "<string>",
"reference": "<string>",
"propertyId": "<string>",
"unitId": "<string>",
"blockId": "<string>",
"location": "<string>",
"manufacturer": "<string>",
"model": "<string>",
"serialNumber": "<string>",
"quantity": 123,
"installedOn": "<string>",
"warrantyExpiresOn": "<string>",
"servicingContactId": "<string>",
"servicingCompanyId": "<string>",
"warrantyProviderContactId": "<string>",
"warrantyProviderCompanyId": "<string>",
"notes": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"id": "<string>",
"name": "<string>",
"category": "boiler",
"reference": "<string>",
"propertyId": "<string>",
"unitId": "<string>",
"blockId": "<string>",
"location": "<string>",
"manufacturer": "<string>",
"model": "<string>",
"serialNumber": "<string>",
"quantity": 123,
"installedOn": "<string>",
"warrantyExpiresOn": "<string>",
"servicingContactId": "<string>",
"servicingCompanyId": "<string>",
"warrantyProviderContactId": "<string>",
"warrantyProviderCompanyId": "<string>",
"notes": "<string>",
"revision": 123,
"archivedAt": "<string>",
"createdAt": "<string>",
"updatedAt": "<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>"
}properties
Create asset
Record an asset on a property or block
POST
/
assets
Create asset
curl --request POST \
--url https://api.sortx.co.uk/assets \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"requestId": "<string>",
"name": "<string>",
"category": "<string>",
"reference": "<string>",
"propertyId": "<string>",
"unitId": "<string>",
"blockId": "<string>",
"location": "<string>",
"manufacturer": "<string>",
"model": "<string>",
"serialNumber": "<string>",
"quantity": 123,
"installedOn": "<string>",
"warrantyExpiresOn": "<string>",
"servicingContactId": "<string>",
"servicingCompanyId": "<string>",
"warrantyProviderContactId": "<string>",
"warrantyProviderCompanyId": "<string>",
"notes": "<string>"
}
'const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
requestId: '<string>',
name: '<string>',
category: '<string>',
reference: '<string>',
propertyId: '<string>',
unitId: '<string>',
blockId: '<string>',
location: '<string>',
manufacturer: '<string>',
model: '<string>',
serialNumber: '<string>',
quantity: 123,
installedOn: '<string>',
warrantyExpiresOn: '<string>',
servicingContactId: '<string>',
servicingCompanyId: '<string>',
warrantyProviderContactId: '<string>',
warrantyProviderCompanyId: '<string>',
notes: '<string>'
})
};
fetch('https://api.sortx.co.uk/assets', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.sortx.co.uk/assets"
payload = {
"requestId": "<string>",
"name": "<string>",
"category": "<string>",
"reference": "<string>",
"propertyId": "<string>",
"unitId": "<string>",
"blockId": "<string>",
"location": "<string>",
"manufacturer": "<string>",
"model": "<string>",
"serialNumber": "<string>",
"quantity": 123,
"installedOn": "<string>",
"warrantyExpiresOn": "<string>",
"servicingContactId": "<string>",
"servicingCompanyId": "<string>",
"warrantyProviderContactId": "<string>",
"warrantyProviderCompanyId": "<string>",
"notes": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"id": "<string>",
"name": "<string>",
"category": "boiler",
"reference": "<string>",
"propertyId": "<string>",
"unitId": "<string>",
"blockId": "<string>",
"location": "<string>",
"manufacturer": "<string>",
"model": "<string>",
"serialNumber": "<string>",
"quantity": 123,
"installedOn": "<string>",
"warrantyExpiresOn": "<string>",
"servicingContactId": "<string>",
"servicingCompanyId": "<string>",
"warrantyProviderContactId": "<string>",
"warrantyProviderCompanyId": "<string>",
"notes": "<string>",
"revision": 123,
"archivedAt": "<string>",
"createdAt": "<string>",
"updatedAt": "<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.
Body
application/json
Response
Success
Available options:
boiler, gas-appliance, heating, electrical, water-system, plumbing, appliance, lift, fire-safety, security, ventilation, communal-area, grounds, roof, other