Retrieve an Equipment

curl --request GET \
  --url https://api.siit.io/v1/equipments/{uid} \
  --header 'Authorization: Bearer <token>'

{
  "uid": "<string>",
  "name": "<string>",
  "serial_number": "<string>",
  "model": "<string>",
  "vendor_name": "<string>",
  "source": "siit",
  "lifecycle": "in_service",
  "os_name": "<string>",
  "processor_type": "<string>",
  "purchase_number": "<string>",
  "keyboard_layout": "<string>",
  "external_url": "<string>",
  "storage_capacity_mb": 123,
  "total_ram_mb": 123,
  "category_uid": "<string>",
  "office_location_uid": "<string>",
  "holder_uid": "<string>",
  "collection_date": "2023-12-25",
  "equipment_issue_date": "2023-12-25",
  "purchase_date": "2023-12-25",
  "guarantee_date": "2023-12-25",
  "last_contact_date": "2023-12-25",
  "last_report_date": "2023-12-25",
  "last_enrollment_date": "2023-12-25",
  "updated_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z"
}

GET

equipments

{uid}

Retrieve an Equipment

curl --request GET \
  --url https://api.siit.io/v1/equipments/{uid} \
  --header 'Authorization: Bearer <token>'

{
  "uid": "<string>",
  "name": "<string>",
  "serial_number": "<string>",
  "model": "<string>",
  "vendor_name": "<string>",
  "source": "siit",
  "lifecycle": "in_service",
  "os_name": "<string>",
  "processor_type": "<string>",
  "purchase_number": "<string>",
  "keyboard_layout": "<string>",
  "external_url": "<string>",
  "storage_capacity_mb": 123,
  "total_ram_mb": 123,
  "category_uid": "<string>",
  "office_location_uid": "<string>",
  "holder_uid": "<string>",
  "collection_date": "2023-12-25",
  "equipment_issue_date": "2023-12-25",
  "purchase_date": "2023-12-25",
  "guarantee_date": "2023-12-25",
  "last_contact_date": "2023-12-25",
  "last_report_date": "2023-12-25",
  "last_enrollment_date": "2023-12-25",
  "updated_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z"
}

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

The UID of the Equipment

name

string

serial_number

string | null

model

string | null

vendor_name

string | null

source

enum<string> | null

default:siit

Where the equipment was discovered from

Available options:

kandji,

siit,

jumpcloud_actions,

intune,

jamf

lifecycle

enum<string> | null

default:in_service

Available options:

in_order,

maintenance,

broken,

outdated,

sold,

reserved,

lost,

in_service,

spare,

stolen

os_name

string | null

processor_type

string | null

purchase_number

string | null

keyboard_layout

string | null

external_url

string | null

storage_capacity_mb

integer | null

total_ram_mb

integer | null

category_uid

string

The UID of the Equipment Category. Default to "Other device"

office_location_uid

string | null

A tag UID of kind "office_location"

holder_uid

string | null

UID of the User to which the resource is attached

collection_date

string<date> | null