Skip to main content
GET
Retrieve an Equipment

Usage

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

uid
string
required

The UID of the Equipment

Response

Equipment show

uid
string
read-only

The UID of the Equipment

The link to the Equipment in Siit admin dashboard

archived_at
string<date-time> | null
read-only

datetime formatted as ISO 8601 (e.g. "2020-12-15T03:34:13.000Z")

added_by

The user created this equipment. Pass ?expand[]=field_name for full object.

category

Category of this equipment. Defaults to "Other device". Pass ?expand[]=field_name for full object.

category_uid
string

DEPRECATED: Use category instead.

collection_date
string<date> | null

date formatted as ISO 8601 (e.g. "2020-12-15")

created_at
string<date-time>
read-only

datetime formatted as ISO 8601 (e.g. "2020-12-15T03:34:13.000Z")

depreciation_rate
number | null
equipment_issue_date
string<date> | null

date formatted as ISO 8601 (e.g. "2020-12-15")

external_id
string | null
read-only
external_url
string | null
read-only
firmware_version
string | null
guarantee_date
string<date> | null

date formatted as ISO 8601 (e.g. "2020-12-15")

holder

The user who holds this equipment. Pass ?expand[]=field_name for full object.

holder_uid
string | null
deprecated

DEPRECATED: Use holder instead. The UID of a user.

ip_address
string | null
keyboard_layout
string | null
last_contact_date
string<date> | null

date formatted as ISO 8601 (e.g. "2020-12-15")

last_enrollment_date
string<date> | null

date formatted as ISO 8601 (e.g. "2020-12-15")

last_maintenance_date
string<date> | null

date formatted as ISO 8601 (e.g. "2020-12-15")

last_report_date
string<date> | null

date formatted as ISO 8601 (e.g. "2020-12-15")

leasing_buyout_option
boolean | null
leasing_company
string | null
leasing_company_contact
string | null
leasing_contract_id
string | null
leasing_end_date
string<date> | null

date formatted as ISO 8601 (e.g. "2020-12-15")

leasing_monthly_cost
number | null
leasing_start_date
string<date> | null

date formatted as ISO 8601 (e.g. "2020-12-15")

leasing_status
enum<string> | null
Available options:
active,
expired
lifecycle
enum<string> | null
default:in_service
Available options:
broken,
in_order,
in_service,
lost,
maintenance,
outdated,
reserved,
sold,
spare,
stolen
mac_address
string | null
model
string | null
name
string
notes
string | null
office_location

Office Location of this equipment. Pass ?expand[]=field_name for full object.

office_location_uid
string | null

DEPRECATED: Use office_location instead.

os_name
string | null
processor_type
string | null
purchase_cost
number | null
purchase_date
string<date> | null

date formatted as ISO 8601 (e.g. "2020-12-15")

purchase_number
string | null
serial_number
string | null
source
enum<string> | null
default:siit
read-only

Where the equipment was discovered from

Available options:
intune,
jamf,
jumpcloud_actions,
kandji,
siit
storage_capacity_mb
integer | null
storage_type
enum<string> | null
Available options:
hdd,
nvme,
other,
ssd
total_ram_mb
integer | null
updated_at
string<date-time>
read-only

datetime formatted as ISO 8601 (e.g. "2020-12-15T03:34:13.000Z")

vendor_name
string | null