Fetch a single asset.

GEThttps://app.softsolz.uk/api/v1/services/appointments/assets/{id}

Recent Requests

TimeStatusUser Agent

Make a request to see history.

Path Params

idstringrequired

Headers

Authorizationstringrequired

Bearer token: `Bearer sk_live_...` (or `sk_test_...` for sandbox). A login token will not work here.

Response

Response Body

idintegerUnique identifier.

customer_idinteger | nullCustomer this belongs to.

parent_asset_idinteger | nullParent asset, so a building can contain rooms.

kindstringYour own word for the thing a visit is about, for example vehicle or property.

namestringDisplay name.

identifierstring | nullRegistration, serial, or reference.

addressobject | nullStreet address and optional coordinates.

custom_fieldsobjectYour own extra fields, keyed by the definitions in workspace settings.

is_activebooleanWhether this record is in use.

created_atstringWhen the record was created.

updated_atstringWhen the record was last changed. Round-trip as expected_updated_at to guard against stale writes.

Request

import { SoftSolz } from '@softsolz/sdk';

const client = new SoftSolz({ apiKey: process.env.SOFTSOLZ_API_KEY });

const result = await client.appointments.getAsset('<id>');
console.log(result);

Credentials

Authorization

Sent as a Bearer token. Stored only in your browser.

Response · 200

{
  "data": {
    "id": 0,
    "customer_id": 0,
    "parent_asset_id": 0,
    "kind": "string",
    "name": "string",
    "identifier": "string",
    "address": "string",
    "custom_fields": {},
    "is_active": true,
    "created_at": "string",
    "updated_at": "string"
  }
}