Skip to main content
GET
Error

Authorizations

Authorization
string
header
required

Prefix the value with "ApiKey" to indicate the custom authorization type

Query Parameters

page
integer<int32>
default:1

Page number (1-based)

size
integer<int32>
default:25

Number of results per page

Required range: x <= 100
warehouseId
string<uuid>

Filter by warehouse ID

categoryCode
string

Filter by category code (e.g. COMPUTER, TABLET)

Response

Paginated list of eligible inventory assets

id
string<uuid>
required

Unique identifier for this inventory item

Example:

"ecb7e933-de1e-9830-b180-b25d1d0d296e"

skuId
string<uuid>
required

The SKU (product variant) ID this inventory item is associated with

Example:

"203a5df2-423a-43a9-bb19-1ccaf3434b91"

imei
string[]
required
deployStatus
enum<string>
required

Current lifecycle state of the inventory item. DEPLOYED = assigned to a person; AVAILABLE = in a warehouse ready to ship; ARCHIVED = permanently decommissioned; UNAVAILABLE = in warehouse but not ready to ship; AWAITING_ARRIVAL = in transit to a warehouse.

Available options:
ARCHIVED,
AVAILABLE,
AWAITING_ARRIVAL,
DEPLOYED,
ON_HOLD,
UNAVAILABLE
Example:

"ARCHIVED"

condition
enum<string>
required

Physical condition of the item (NEW or USED)

Available options:
NEW,
USED_LIKE_NEW,
USED_GOOD,
USED_FAIR,
USED,
USED_POOR,
UNUSABLE
Example:

"NEW"

categoryCode
string
required

Category code of the SKU (e.g. COMPUTER, MONITOR, HEADSET)

Example:

"TSHIRT"

categoryNameOfSku
string
required

Human-readable category name for the SKU

Example:

"T-shirt"

skuTitle
string
required

Display title of the SKU (product variant name)

Example:

"T-shirt White - 5XL"

vendorCode
string
required

Vendor/brand code for the SKU

Example:

"AWESOME_MERCHANDISE"

vendorSku
string
required

Vendor-specific SKU or model identifier

Example:

"TSHRT_5XL_WHITE"

createdAt
string<date-time>
required

Timestamp when this inventory item was created in Firstbase

Example:

"2023-02-09T00:00:00"

updatedAt
string<date-time>
required

Timestamp when this inventory item was last updated

Example:

"2023-03-02T17:39:01.650027"

tags
object[]
required

List of key-value tags attached to this inventory item for organization and filtering.

serialNumber
string

Hardware serial number of the device; null for non-serialized items

Example:

"25f2e6ea9a"

deployReason
enum<string>

Reason code explaining why the item is in its current deployStatus. Required when transitioning to UNAVAILABLE or ARCHIVED; null when DEPLOYED or AVAILABLE.

Available options:
ASSIGNED_TO_ADMIN,
AWAITING_INFORMATION,
BOUGHT_OUT,
DATA_HOLD,
DECOMMISSIONED_BY_EMPLOYER,
END_OF_USEFUL_LIFE_DESTROYED,
END_OF_USEFUL_LIFE_DONATED,
PENDING_FULFILLMENT,
GIFTED_BY_EMPLOYER,
GIFTED_BY_FIRSTBASE,
IN_TRANSIT,
LOCKED_APPLE_ACTIVATION,
LOCKED_FMD_REPORTED_LOST_STOLEN,
LOCKED_MDM,
LOCKED_PIN,
LOST_BY_FIRSTBASE,
LOST_IN_TRANSIT,
LOST_BY_WORKER,
MARKED_FOR_DESTRUCTION,
NA,
NEVER_RECEIVED_BY_WORKER,
OTHER,
OUT_FOR_DESTRUCTION,
OUT_FOR_REPAIR,
PENDING_BUY_OUT,
RECYCLING_REQUESTED,
REQUIRES_CLEANING,
REQUIRES_REPAIR,
RETURN_IN_PROGRESS,
SENT_TO_OFFICE,
STOLEN,
UNRESPONSIVE_WORKER,
UNSUPPORTED_REGION,
PERSONAL_DEVICE,
PENDING_HOLD_RELEASE
Example:

"LOST_BY_WORKER"

renewalDate
string<date>

Date when this item is scheduled for renewal or replacement

Example:

"2026-02-09"

renewalDateUpdatedBy
enum<string>

Who or what last set the renewalDate (e.g. organization policy vs. manual override)

Available options:
RENEWAL_DATE_ORGANIZATION_LEVEL,
RENEWAL_DATE_ORGANIZATION_CATEGORY_LEVEL,
RENEWAL_DATE_MANUALLY_UPDATED,
CLEAR_RENEWAL_DATE_MANUALLY_SET
Example:

"RENEWAL_DATE_ORGANIZATION_LEVEL"

billingStartDate
string<date>

Date when billing began for this inventory item

Example:

"2026-02-09"

billingEndDate
string<date>

Date when billing ended or is scheduled to end for this inventory item

Example:

"2028-02-09"

procurementMethod
string

Human-readable label indicating how this item was procured (e.g. via an inventory order ID)

Example:

"Inventory Order - #c853d81c-ba0b-4027-a394-d5586b61608c"

returnOrder
object

Details of the return order associated with this inventory item, if a return has been initiated.

assignedTo
object

Information about the person this inventory item is currently assigned to, if applicable.

pricing
object

Pricing details

description
string

Custom description for the inventory item

Example:

"Custom inventory description"

netsuiteInvoiceId
string

NetSuite invoice ID for Firstbase-supplied inventory

Example:

"INV-123456"

holdStartDate
string<date>

Date when the machine retention hold started (set at warehouse receive). Null when no hold is active.

unlockDate
string<date>

Date when the machine retention hold expires (holdStartDate + holdPeriodDays). Null when no hold is active.

itadRequested
boolean

Whether ITAD was requested for this item. Copied from the return order item at hold-stamp time.

appleBusiness
object

Apple Business Manager assignment for serialized Apple inventory. Omitted for non-Apple or non-serialized items.