List assets

GET

/api/assets

const url = 'http://localhost:3000/api/assets?status=active&assigned=true';
const options = {method: 'GET', headers: {cookie: 'session=<session>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'http://localhost:3000/api/assets?status=active&assigned=true' \
  --cookie session=<session>

Not paginated. Rows include joined category/manufacturer/site/location names and the current assignee.

Authorizations

cookieAuth

Parameters

Query Parameters

category

string

Filter by category slug

status

string

Allowed values: active spare maintenance retired decommissioned lost stolen

Filter by status

assigned

string

Allowed values: true false

True = only assets with an open assignment, false = only unassigned

search

string

Match across name, asset tag, and custom field values

Responses

200

Success

application/json

object

data

Array<object>

object

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

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

Example

{
  "data": [
    {
      "status": "active",
      "condition": "good"
    }
  ]
}

401

Not authenticated

application/json

object

error

required

string

Example

{
  "error": "Not found"
}