v1

latestOpenAPI 3.1.02026-07-2466150275.0 KB

Assets

Search Assets

Search for assets that match the provided search terms.

Keywords are searched for in the name, vin, model and colour fields.

Additional explicit filters are also supported

get/v1/asset/

Query parameters

querystring nullable

skipinteger nullable

limitinteger nullable

sort_direction'asc' | 'desc'

Direction to sort the sort_column - ascending or descending.

date_startstring date-time nullable

date_cut_offstring date-time nullable

sort_column'updated_at' | 'created_at' | 'id'

Which column to sort on

type_idinteger nullable

project_idinteger nullable

project_id_isnullboolean nullable

modelstring nullable

colourstring nullable

is_maintenance_requiredboolean nullable

is_archivedboolean nullable

Response

Successful Response

errorboolean

A boolean error indicator.

messagestring nullable

Optional message.

Example response

{
  "data": [
    {
      "companyId": 1,
      "id": 1,
      "name": "Forklift",
      "typeId": 3,
      "siteId": 11,
      "fuelTypeId": 2,
      "vin": "911 230 0001",
      "model": "Model S",
      "description": "The description of the asset",
      "colour": "Blue",
      "image": "/upload/find/example-asset.png",
      "cost": 35000,
      "lastCheckin": "2026-07-17T21:40:53.156848",
      "lastMaintenance": "2026-07-17T21:40:53.156877",
      "insuranceDate": "2026-07-17T21:40:53.156902"
    }
  ]
}