API docs by Redocly

Asset Unit API (1.0.0)

Download OpenAPI specification:Download

API for managing asset units

Asset Unit

Asset unit management operations

Get all asset units

Retrieve a list of all asset units with optional filtering and pagination

Authorizations:
ApiKeyAuth
query Parameters
page
integer >= 1
Default: 1

Page number for pagination

per_page
integer [ 1 .. 100 ]
Default: 25

Number of items per page

sort
string

Sort field

company_namespace
Array of strings

Company namespace for filtering

asset
string

Filter by asset ID

status
string
Enum: "active" "maintenance" "retired" "disposed"

Filter by status

location
string

Filter by location

_id
Array of strings

Filter by ID

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "paging": {
    }
}

Create a new asset unit

Create a new asset unit entry

Authorizations:
ApiKeyAuth
Request Body schema: application/json
asset
required
string

Asset ID reference

serial_number
required
string

Unique serial number for this unit

barcode
string

Barcode identifier

status
string
Default: "active"
Enum: "active" "maintenance" "retired" "disposed"

Initial status of the asset unit

condition
string
Default: "good"
Enum: "excellent" "good" "fair" "poor"

Physical condition of the asset

location
string

Current location of the asset unit

assigned_to
string

User or department assigned to this asset

purchase_date
string <date>

Date when the asset unit was purchased

warranty_expiry
string <date>

Warranty expiration date

purchase_cost
number <float>

Original purchase cost

object
notes
string

Additional notes about the asset unit

custom_fields
object

Custom fields for additional data

company_namespace
Array of strings

Company namespace

disabled
boolean
Default: false

Whether the asset unit is disabled

Responses

Request samples

Content type
application/json
{
  • "asset": "507f1f77bcf86cd799439012",
  • "serial_number": "AST-001-2024",
  • "barcode": "string",
  • "status": "active",
  • "condition": "excellent",
  • "location": "string",
  • "assigned_to": "string",
  • "purchase_date": "2019-08-24",
  • "warranty_expiry": "2019-08-24",
  • "purchase_cost": 0,
  • "depreciation": {
    },
  • "notes": "string",
  • "custom_fields": { },
  • "company_namespace": [
    ],
  • "disabled": false
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Get asset unit by ID

Retrieve a specific asset unit by its ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Asset unit ID

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Update asset unit

Update an existing asset unit

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Asset unit ID

Request Body schema: application/json
serial_number
string

Unique serial number for this unit

barcode
string

Barcode identifier

status
string
Enum: "active" "maintenance" "retired" "disposed"

Status of the asset unit

condition
string
Enum: "excellent" "good" "fair" "poor"

Physical condition of the asset

location
string

Current location of the asset unit

assigned_to
string

User or department assigned to this asset

purchase_date
string <date>

Date when the asset unit was purchased

warranty_expiry
string <date>

Warranty expiration date

last_maintenance
string <date-time>

Date of last maintenance

next_maintenance
string <date>

Date of next scheduled maintenance

purchase_cost
number <float>

Original purchase cost

object
notes
string

Additional notes about the asset unit

custom_fields
object

Custom fields for additional data

company_namespace
Array of strings

Company namespace

disabled
boolean

Whether the asset unit is disabled

Responses

Request samples

Content type
application/json
{
  • "serial_number": "string",
  • "barcode": "string",
  • "status": "active",
  • "condition": "excellent",
  • "location": "string",
  • "assigned_to": "string",
  • "purchase_date": "2019-08-24",
  • "warranty_expiry": "2019-08-24",
  • "last_maintenance": "2019-08-24T14:15:22Z",
  • "next_maintenance": "2019-08-24",
  • "purchase_cost": 0,
  • "depreciation": {
    },
  • "notes": "string",
  • "custom_fields": { },
  • "company_namespace": [
    ],
  • "disabled": true
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Delete asset unit

Delete an asset unit by ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Asset unit ID

Responses

Response samples

Content type
application/json
{
  • "success": true
}

Bulk delete asset units

Delete multiple asset units by their IDs

Authorizations:
ApiKeyAuth
Request Body schema: application/json
ids
required
Array of strings

Array of asset unit IDs to delete

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true
}

Update asset unit status

Update the status of an asset unit

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Asset unit ID

Request Body schema: application/json
status
required
string
Enum: "active" "maintenance" "retired" "disposed"

New status for the asset unit

reason
string

Reason for status change

notes
string

Additional notes

Responses

Request samples

Content type
application/json
{
  • "status": "active",
  • "reason": "string",
  • "notes": "string"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}