Skip to content

Get asset

GET
/api/assets/{id}
curl --request GET \
--url http://localhost:3000/api/assets/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
--cookie session=<session>

Includes category (with field definitions), custom fieldValues, currentAssignee, and assignmentHistory.

id
required
string format: uuid

Success

Media type application/json
object
data
object
id
required
string format: uuid
name
required
string
assetTag
string
nullable
serialNumber
string
nullable
status
required
string
Allowed values: active spare maintenance retired decommissioned lost stolen
condition
string
default: good
categoryId
string format: uuid
nullable
categoryName
string
nullable
categorySlug
string
nullable
manufacturerId
string format: uuid
nullable
manufacturerName
string
nullable
siteId
string format: uuid
nullable
siteName
string
nullable
locationId
string format: uuid
nullable
locationName
string
nullable
purchaseOrderId
string format: uuid
nullable
purchasedAt
string format: date-time
nullable
warrantyUntil
string format: date-time
nullable
purchasePrice

Numeric(10,2) serialised as string

string
nullable
notes
string
nullable
currentAssignee
object
id
string format: uuid
fullName
string
nullable
email
string
nullable
personId
string format: uuid
nullable
userId
string format: uuid
nullable
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
category
object
id
required
string format: uuid
name
required
string
slug
string
nullable
icon
string
default: package
description
string
nullable
fields
Array<object>
object
id
required
string format: uuid
categoryId
required
string format: uuid
fieldKey
required
string
label
required
string
fieldType
required
string
default: text
options
Array<string>
nullable
required
boolean
placeholder
string
nullable
helpText
string
nullable
sortOrder
integer
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
fieldValues
object
key
additional properties
string
assignmentHistory
Array<object>
object
id
required
string format: uuid
assetId
required
string format: uuid
personId
string format: uuid
nullable
userId
string format: uuid
nullable
assignedAt
required
string format: date-time
returnedAt
string format: date-time
nullable
notes
string
nullable
personName
string
nullable
personEmail
string
nullable
Example
{
"data": {
"status": "active",
"condition": "good",
"category": {
"icon": "package",
"fields": [
{
"fieldType": "text"
}
]
}
}
}

Not authenticated

Media type application/json
object
error
required
string
Example
{
"error": "Not found"
}

Asset not found

Media type application/json
object
error
required
string
Example
{
"error": "Not found"
}