Returns a list of assets for your company, including joined location, vendor, owner, and classification names.

Query parameters

curl "https://scoutmon.com/api/assets?status=checked-out&sort_by=name&sort_dir=asc&limit=25" \
  -H "Authorization: Bearer sk_..."

[
  {
    "id": "a1b2c3d4-...",
    "asset_tag": "IT-0042",
    "name": "MacBook Pro 16\"",
    "category": "Laptop",
    "status": "checked-out",
    "value": "2499.00",
    "location_name": "Sydney HQ",
    "vendor_name": "Apple Inc.",
    "assigned_user_name": "Alice Smith",
    "created_at": "2025-11-01T09:00:00.000Z"
  }
]

The response header X-Total-Count contains the total number of matching assets (before pagination).

Returns a single asset by ID. Use GET /api/assets/:id/decrypt (admin-only) to retrieve encrypted serial/notes fields.

curl https://scoutmon.com/api/assets/a1b2c3d4-... \
  -H "Authorization: Bearer sk_..."

Creates a new asset. If asset_tag is omitted and auto-increment is configured, a tag is generated automatically.

Body parameters

curl -X POST https://scoutmon.com/api/assets \
  -H "Authorization: Bearer sk_..." \
  -H "Content-Type: application/json" \
  -d '{
    "name": "MacBook Pro 16\"",
    "category": "Laptop",
    "manufacturer": "Apple",
    "model": "MacBook Pro 16\" M3",
    "value": 2499,
    "purchase_date": "2025-10-15",
    "warranty_expiry": "2028-10-15"
  }'

Replaces all fields on an asset. Send all fields (including unchanged ones) — this is a full update, not a partial patch. Accepts the same body parameters as POST /api/assets.

Permanently deletes an asset. This action cannot be undone.

{ "ok": true }

Checks an asset out to a user. Sets status to checked-out and records the assignment.

Body parameters

Checks an asset back in. Sets status to checked-in and clears the assigned user.

Returns all users in your company. Includes role, status, department, and last login timestamp.

Query parameters

curl "https://scoutmon.com/api/users?role=admin" \
  -H "Authorization: Bearer sk_..."

[
  {
    "id": "u1b2c3d4-...",
    "name": "Alice Smith",
    "email": "[email protected]",
    "role": "admin",
    "status": "active",
    "department": "Engineering",
    "last_login": "2026-03-28T14:22:00.000Z",
    "created_at": "2025-09-01T08:00:00.000Z"
  }
]

Invites a new user. Sends an invitation email with a password-set link valid for 7 days.

Body parameters

Partially updates a user's name, role, or department.

Body parameters

Returns all hardware assets and license seats currently assigned to a specific user.

{
  "assets": [ /* hardware assets assigned to this user */ ],
  "seats": [ /* software license seats assigned to this user */ ]
}

Returns all vendors for your company with risk rating, compliance status, and contact details.

Query parameters

Creates a new vendor record.

Body parameters

Full update of a vendor record. Accepts the same fields as POST /api/vendors.

Returns all active assets associated with a vendor.

Returns all locations for your company.

Query parameters

[
  {
    "id": "loc1b2c3-...",
    "name": "Sydney HQ",
    "type": "Office",
    "address": "123 Pitt St, Sydney NSW 2000",
    "lat": -33.8688,
    "lng": 151.2093
  }
]

Creates a new location.

Body parameters

Global search across assets, users, and vendors. Returns up to 5 results per category.

Query parameters

curl "https://scoutmon.com/api/search?q=macbook" \
  -H "Authorization: Bearer sk_..."

{
  "assets": [
    { "id": "...", "name": "MacBook Pro 16\"", "asset_tag": "IT-0042", "category": "Laptop", "status": "checked-out" }
  ],
  "users": [],
  "vendors": []
}