Browse docs

Assets API

Read assets and their associated details from Scan2Evolve for CMMS, ERP, or reporting integrations. This API is read-only and is designed to complement the Asset Sync API.

List assets

Retrieve all assets for the authenticated organisation. You can filter by site, asset type, status, or an external identifier stored in custom fields.

Request

GET /api/v1/assets HTTP/1.1
Host: api.scan2evolve.com
Authorization: Bearer YOUR_API_TOKEN
Accept: application/json

Response

HTTP/1.1 200 OK
Content-Type: application/json

[
  {
    "id": "asset_123",
    "name": "Boiler 1",
    "code": "BOIL-001",
    "status": "ACTIVE",
    "qrSlug": "org_123-asset_123",
    "organizationId": "org_123",
    "assetType": {
      "id": "atype_1",
      "name": "Boiler"
    },
    "site": {
      "id": "site_123",
      "name": "Melbourne Warehouse",
      "code": "MEL-WH"
    },
    "createdAt": "2025-12-01T10:00:00Z",
    "updatedAt": "2025-12-02T09:30:00Z"
  }
]

Filters

  • siteId – return only assets at a specific site.
  • assetTypeId – return only assets of a specific asset type.
  • status – filter by asset status (ACTIVE, INACTIVE, or RETIRED).
  • externalAssetId – match a value stored in custom fields (for example, an ERP asset ID).

Example with filters

GET /api/v1/assets?siteId=site_123&status=ACTIVE HTTP/1.1
Host: api.scan2evolve.com
Authorization: Bearer YOUR_API_TOKEN
Accept: application/json

Get an asset

Retrieve a single asset by ID, including basic details, site and asset type, documents, and meters. Use this when you need the full context of an asset in another system.

Request

GET /api/v1/assets/asset_123 HTTP/1.1
Host: api.scan2evolve.com
Authorization: Bearer YOUR_API_TOKEN
Accept: application/json

Response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "id": "asset_123",
  "name": "Boiler 1",
  "code": "BOIL-001",
  "status": "ACTIVE",
  "qrSlug": "org_123-asset_123",
  "organizationId": "org_123",
  "assetType": {
    "id": "atype_1",
    "name": "Boiler"
  },
  "site": {
    "id": "site_123",
    "name": "Melbourne Warehouse",
    "code": "MEL-WH"
  },
  "description": "Main production boiler",
  "createdAt": "2025-12-01T10:00:00Z",
  "updatedAt": "2025-12-02T09:30:00Z",
  "documents": [
    {
      "id": "doc_1",
      "name": "Manual.pdf",
      "mimeType": "application/pdf",
      "size": 123456,
      "createdAt": "2025-11-30T09:00:00Z"
    }
  ],
  "meters": [
    {
      "id": "am_1",
      "meterId": "meter_1",
      "isActive": true,
      "installedAt": "2025-11-01T00:00:00Z",
      "equipmentStatus": "EQUIPPED",
      "meter": {
        "id": "meter_1",
        "name": "Run hours",
        "code": "HOURS",
        "unit": "H",
        "readingType": "CUMULATIVE"
      }
    }
  ]
}
Top