Snipe-IT

App · 25 actions

Manage Snipe-IT assets, companies and locations and check assets in and out.

Actions

ActionWhat it does
Check in assetCheck in asset.
Check out assetCheck out asset.
Create assetCreate asset.
Create companyCreate company.
Create locationCreate location.
Delete assetDelete asset.
Delete companyDelete company.
Delete locationDelete location.
Get assetGet asset.
Get asset modelGet asset model.
Get companyGet company.
Get locationGet location.
Get status labelGet status label.
Get userGet user.
List asset modelsList asset models.
List assetsList assets.
List categoriesList categories.
List companiesList companies.
List locationsList locations.
List manufacturersList manufacturers.
List status labelsList status labels.
List usersList users.
Update assetUpdate asset.
Update companyUpdate company.
Update locationUpdate location.

Check in asset

Check in asset. Returns the service response.

Inputs

IdidnumberRequired
Id.
Statusstatus_idnumberRequired
Status id.
Namenametext
Name.
Notenotetext
Note.
Locationlocation_idtext
Location id.

Outputs

dataobject
The complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page cursor.
Example output
{
  "data": {
    "messages": "example",
    "status": "example"
  },
  "has_more": false,
  "next_cursor": "example"
}

Check out asset

Check out asset. Returns the service response.

Inputs

IdidnumberRequired
Id.
Statusstatus_idnumberRequired
Status id.
Checkout to typecheckout_to_typetextRequired
Checkout to type.One of: user, asset, location.
Assigned userassigned_usernumber
Assigned user.
Assigned assetassigned_assetnumber
Assigned asset.
Assigned locationassigned_locationnumber
Assigned location.
Expected checkinexpected_checkindate
Expected checkin.
Checkout atcheckout_atdate
Checkout at.
Namenametext
Name.
Notenotetext
Note.

Outputs

dataobject
The complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page cursor.
Example output
{
  "data": {
    "messages": "example",
    "status": "example"
  },
  "has_more": false,
  "next_cursor": "example"
}

Create asset

Create asset. Returns the service response.

Inputs

Asset tagasset_tagtextRequired
Asset tag.
Statusstatus_idnumberRequired
Status id.
Modelmodel_idnumberRequired
Model id.
Namenametext
Name.
Imageimagetext
Image.
Serialserialtext
Serial.
Purchase datepurchase_datedate
Purchase date.
Purchase costpurchase_costnumber
Purchase cost.
Order numberorder_numbertext
Order number.
Notesnotestext
Notes.
Archivedarchivedtrue/false
Archived.
Warranty monthswarranty_monthsnumber
Warranty months.
Depreciatedepreciatetrue/false
Depreciate.
Supplier idsupplier_idnumber
Supplier id.
Requestablerequestabletrue/false
Requestable.
Rtd location idrtd_location_idnumber
Rtd location id.
Last audit datelast_audit_datedate
Last audit date.
Locationlocation_idnumber
Location id.
Byodbyodtrue/false
Byod.

Outputs

dataobject
The complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page cursor.
Example output
{
  "data": {
    "messages": "example",
    "payload": {
      "archived": "example",
      "asset_tag": "example",
      "assigned_to": "example",
      "company_id": "example",
      "created_at": "example",
      "depreciate": "example",
      "id": 1,
      "model": {
        "category_id": 1,
        "created_at": "example",
        "deprecated_mac_address": 1,
        "depreciation_id": 1,
        "eol": 1,
        "fieldset_id": "example",
        "id": 1,
        "image": "example",
        "manufacturer_id": 1,
        "model_number": "example",
        "name": "example",
        "notes": "example",
        "requestable": 1,
        "updated_at": "example"
      },
      "model_id": 1,
      "name": "example",
      "notes": "example",
      "order_number": "example",
      "physical": "example",
      "purchase_cost": "example",
      "purchase_date": "example",
      "requestable": 1,
      "rtd_location_id": "example",
      "serial": "example",
      "status_id": 1,
      "supplier_id": "example",
      "updated_at": "example",
      "user_id": 1,
      "warranty_months": "example"
    },
    "status": "example"
  },
  "has_more": false,
  "next_cursor": "example"
}

Create company

Create company. Returns the service response.

Inputs

NamenametextRequired
Name.

Outputs

dataobject
The complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page cursor.
Example output
{
  "data": {
    "messages": "example",
    "payload": {
      "created_at": "example",
      "id": 1,
      "name": "example",
      "updated_at": "example"
    },
    "status": "example"
  },
  "has_more": false,
  "next_cursor": "example"
}

Create location

Create location. Returns the service response.

Inputs

NamenametextRequired
Name.
Addressaddresstext
Address.
Address2address2text
Address2.
Citycitytext
City.
Statestatetext
State.
Countrycountrytext
Country.
Zipziptext
Zip.
Ldap ouldap_outext
Ldap ou.
Parent idparent_idnumber
Parent id.
Currencycurrencytext
Currency.
Manager idmanager_idnumber
Manager id.
Companycompany_idnumber
Company id.

Outputs

dataobject
The complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page cursor.
Example output
{
  "data": {},
  "has_more": false,
  "next_cursor": "example"
}

Delete asset

Delete asset. Returns the service response.

Inputs

IdidnumberRequired
Id.

Outputs

dataobject
Data.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page cursor.
Example output
{
  "data": {
    "messages": "example",
    "payload": {},
    "status": "example"
  },
  "has_more": false,
  "next_cursor": "example"
}

Delete company

Delete company. Returns the service response.

Inputs

IdidnumberRequired
Id.

Outputs

dataobject
The complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page cursor.
Example output
{
  "data": {
    "messages": "example",
    "status": "example"
  },
  "has_more": false,
  "next_cursor": "example"
}

Delete location

Delete location. Returns the service response.

Inputs

IdidnumberRequired
Id.

Outputs

dataobject
The complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page cursor.
Example output
{
  "data": {
    "messages": "example",
    "payload": "example",
    "status": "example"
  },
  "has_more": false,
  "next_cursor": "example"
}

Get asset

Get asset. Returns the service response.

Inputs

IdidnumberRequired
Id.

Outputs

dataobject
The complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page cursor.
Example output
{
  "data": {
    "age": "example",
    "alt_barcode": "example",
    "asset_tag": "example",
    "assigned_to": {
      "id": 1,
      "name": "example",
      "type": "example"
    },
    "available_actions": {
      "checkin": false,
      "checkout": false,
      "clone": false,
      "delete": false,
      "restore": false,
      "update": false
    },
    "category": {
      "id": 1,
      "name": "example"
    },
    "checkin_counter": 1,
    "checkout_counter": 1,
    "company": "example",
    "created_at": {
      "datetime": "example",
      "formatted": "example"
    },
    "custom_fields": {
      "CPU": {
        "element": "example",
        "field": "example",
        "field_format": "example",
        "value": "example"
      },
      "MAC Address": {
        "element": "example",
        "field": "example",
        "field_format": "example",
        "value": "example"
      },
      "RAM": {
        "element": "example",
        "field": "example",
        "field_format": "example",
        "value": "example"
      }
    },
    "deleted_at": "example",
    "eol": {
      "date": "example",
      "formatted": "example"
    },
    "expected_checkin": "example",
    "id": 1,
    "image": "example",
    "last_audit_date": "example",
    "last_checkout": "example",
    "location": {
      "id": 1,
      "name": "example"
    },
    "manufacturer": "example",
    "model": {
      "id": 1,
      "name": "example"
    },
    "model_number": "example",
    "name": "example",
    "next_audit_date": "example",
    "notes": "example",
    "order_number": "example",
    "purchase_cost": "example",
    "purchase_date": {
      "date": "example",
      "formatted": "example"
    },
    "qr": "example",
    "requests_counter": 1,
    "rtd_location": {
      "id": 1,
      "name": "example"
    },
    "serial": "example",
    "status_label": {
      "id": 1,
      "name": "example",
      "status_meta": "example",
      "status_type": "example"
    },
    "supplier": {
      "id": 1,
      "name": "example"
    },
    "updated_at": {
      "datetime": "example",
      "formatted": "example"
    },
    "user_can_checkout": false,
    "warranty_expires": "example",
    "warranty_months": "example"
  },
  "has_more": false,
  "next_cursor": "example"
}

Get asset model

Get asset model. Returns the service response.

Inputs

IdidnumberRequired
Id.

Outputs

dataobject
The complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page cursor.
Example output
{
  "data": {
    "created_at": "example",
    "id": 1,
    "name": "example",
    "updated_at": "example"
  },
  "has_more": false,
  "next_cursor": "example"
}

Get company

Get company. Returns the service response.

Inputs

IdidnumberRequired
Id.

Outputs

dataobject
The complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page cursor.
Example output
{
  "data": {
    "accessories_count": 1,
    "assets_count": 1,
    "available_actions": {
      "delete": false,
      "update": false
    },
    "components_count": 1,
    "consumables_count": 1,
    "created_at": {
      "datetime": "example",
      "formatted": "example"
    },
    "id": 1,
    "image": "example",
    "licenses_count": 1,
    "name": "example",
    "updated_at": {
      "datetime": "example",
      "formatted": "example"
    },
    "users_count": 1
  },
  "has_more": false,
  "next_cursor": "example"
}

Get location

Get location. Returns the service response.

Inputs

IdidnumberRequired
Id.

Outputs

dataobject
The complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page cursor.
Example output
{
  "data": {},
  "has_more": false,
  "next_cursor": "example"
}

Get status label

Get status label. Returns the service response.

Inputs

IdidnumberRequired
Id.

Outputs

dataobject
The complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page cursor.
Example output
{
  "data": {
    "assets_count": 1,
    "available_actions": {
      "delete": false,
      "update": false
    },
    "color": "example",
    "created_at": {
      "datetime": "example",
      "formatted": "example"
    },
    "id": 1,
    "name": "example",
    "notes": "example",
    "show_in_nav": false,
    "type": "example",
    "updated_at": {
      "datetime": "example",
      "formatted": "example"
    }
  },
  "has_more": false,
  "next_cursor": "example"
}

Get user

Get user. Returns the service response.

Inputs

IdidnumberRequired
Id.

Outputs

dataobject
The complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page cursor.
Example output
{
  "data": {},
  "has_more": false,
  "next_cursor": "example"
}

List asset models

List asset models. Returns one page; use the next page cursor to continue.

Inputs

Limitlimitnumber
Limit.
Offsetoffsetnumber
Offset.At least 0.
Searchsearchtext
Search.
Sortsorttext
Sort.
Orderordertext
Order.One of: asc, desc.
Namenametext
Name.
Notesnotestext
Notes.
Model numbermodel_numbertext
Model number.
Category idcategory_idnumber
Category id.
Depreciation iddepreciation_idnumber
Depreciation id.
Requestablerequestabletrue/false
Requestable.

Outputs

dataobject
The complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page cursor.
Example output
{
  "data": {
    "rows": []
  },
  "has_more": false,
  "next_cursor": "example"
}

List assets

List assets. Returns one page; use the next page cursor to continue.

Inputs

Limitlimitnumber
Limit.
Offsetoffsetnumber
Offset.At least 0.
Searchsearchtext
Search.
Order numberorder_numbertext
Order number.
Sortsorttext
Sort.
Orderordertext
Order.One of: asc, desc.
Modelmodel_idnumber
Model id.
Category idcategory_idnumber
Category id.
Manufacturer idmanufacturer_idnumber
Manufacturer id.
Companycompany_idnumber
Company id.
Locationlocation_idnumber
Location id.
Statusstatustext
Status.
Statusstatus_idnumber
Status id.
Assigned toassigned_tonumber
Assigned to.
Assigned typeassigned_typetext
Assigned type.One of: App\Models\Asset, App\Models\Accessory, App\Models\User.
Filterfiltertext
Filter.

Outputs

dataobject
The complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page cursor.
Example output
{
  "data": {
    "name": "example",
    "rows": []
  },
  "has_more": false,
  "next_cursor": "example"
}

List categories

List categories. Returns one page; use the next page cursor to continue.

Inputs

Namenametext
Name.
Limitlimitnumber
Limit.
Offsetoffsetnumber
Offset.At least 0.
Searchsearchtext
Search.
Sortsorttext
Sort.
Orderordertext
Order.One of: asc, desc.
Category idcategory_idnumber
Category id.
Category typecategory_typetext
Category type.One of: asset, accessory, consumable, component, license.
Use default eulause_default_eulatrue/false
Use default eula.
Require acceptancerequire_acceptancetrue/false
Require acceptance.
Checkin emailcheckin_emailtrue/false
Checkin email.

Outputs

dataobject
The complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page cursor.
Example output
{
  "data": {
    "rows": []
  },
  "has_more": false,
  "next_cursor": "example"
}

List companies

List companies. Returns the service response.

Inputs

Namenametext
Name.

Outputs

dataobject
The complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page cursor.
Example output
{
  "data": {
    "rows": [],
    "total": 1
  },
  "has_more": false,
  "next_cursor": "example"
}

List locations

List locations. Returns one page; use the next page cursor to continue.

Inputs

Namenametext
Name.
Limitlimitnumber
Limit.
Offsetoffsetnumber
Offset.At least 0.
Searchsearchtext
Search.
Sortsorttext
Sort.
Orderordertext
Order.One of: asc, desc.
Addressaddresstext
Address.
Address2address2text
Address2.
Citycitytext
City.
Zipziptext
Zip.
Countrycountrytext
Country.

Outputs

dataobject
The complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page cursor.
Example output
{
  "data": {
    "rows": []
  },
  "has_more": false,
  "next_cursor": "example"
}

List manufacturers

List manufacturers. Returns the service response.

Inputs

Namenametext
Name.
Urlurltext
Url.
Support urlsupport_urltext
Support url.
Support phonesupport_phonetext
Support phone.
Support emailsupport_emailtext
Support email.

Outputs

dataobject
The complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page cursor.
Example output
{
  "data": {
    "rows": [],
    "total": 1
  },
  "has_more": false,
  "next_cursor": "example"
}

List status labels

List status labels. Returns one page; use the next page cursor to continue.

Inputs

Namenametext
Name.
Limitlimitnumber
Limit.
Offsetoffsetnumber
Offset.At least 0.
Searchsearchtext
Search.
Sortsorttext
Sort.
Orderordertext
Order.One of: asc, desc.
Status typestatus_typetext
Status type.One of: deployable, undeployable, pending, archived.

Outputs

dataobject
The complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page cursor.
Example output
{
  "data": {
    "rows": [],
    "total": 1
  },
  "has_more": false,
  "next_cursor": "example"
}

List users

List users. Returns one page; use the next page cursor to continue.

Inputs

Searchsearchtext
Search.
Limitlimitnumber
Limit.
Offsetoffsetnumber
Offset.At least 0.
Sortsorttext
Sort.
Orderordertext
Order.One of: asc, desc.
First namefirst_nametext
First name.
Last namelast_nametext
Last name.
Usernameusernametext
Username.
Emailemailtext
Email.
Employee numemployee_numtext
Employee num.
Statestatetext
State.
Zipziptext
Zip.
Countrycountrytext
Country.
Group idgroup_idnumber
Group id.
Department iddepartment_idnumber
Department id.
Companycompany_idnumber
Company id.
Locationlocation_idnumber
Location id.
Deleteddeletedtrue/false
Deleted.
Allalltrue/false
All.
Ldap importldap_importtrue/false
Ldap import.
Assets countassets_countnumber
Assets count.
Licenses countlicenses_countnumber
Licenses count.
Accessories countaccessories_countnumber
Accessories count.
Consumables countconsumables_countnumber
Consumables count.
Remoteremotetrue/false
Remote.
Vipviptrue/false
Vip.
Start datestart_datedate
Start date.
End dateend_datedate
End date.
Filterfiltertext
Filter.

Outputs

dataobject
The complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page cursor.
Example output
{
  "data": {
    "rows": []
  },
  "has_more": false,
  "next_cursor": "example"
}

Update asset

Update asset. Returns the service response.

Inputs

IdidnumberRequired
Id.
Asset tagasset_tagtext
Asset tag.
Notesnotestext
Notes.
Statusstatus_idnumber
Status id.
Modelmodel_idnumber
Model id.
Last checkoutlast_checkoutdate
Last checkout.
Assigned userassigned_usernumber
Assigned user.
Assigned locationassigned_locationnumber
Assigned location.
Assigned assetassigned_assetnumber
Assigned asset.
Companycompany_idnumber
Company id.
Serialserialtext
Serial.
Order numberorder_numbertext
Order number.
Warranty monthswarranty_monthsnumber
Warranty months.
Purchase costpurchase_costnumber
Purchase cost.
Purchase datepurchase_datedate
Purchase date.
Requestablerequestabletrue/false
Requestable.
Archivedarchivedtrue/false
Archived.
Rtd location idrtd_location_idnumber
Rtd location id.
Namenametext
Name.
Locationlocation_idtext
Location id.
Byodbyodnumber
Byod.

Outputs

dataobject
Data.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page cursor.
Example output
{
  "data": {
    "messages": "example",
    "payload": {},
    "status": "example"
  },
  "has_more": false,
  "next_cursor": "example"
}

Update company

Update company. Returns the service response.

Inputs

IdidnumberRequired
Id.
NamenametextRequired
Name.

Outputs

dataobject
The complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page cursor.
Example output
{
  "data": {
    "created_at": "example",
    "id": 1,
    "name": "example",
    "updated_at": "example"
  },
  "has_more": false,
  "next_cursor": "example"
}

Update location

Update location. Returns the service response.

Inputs

IdidnumberRequired
Id.
Namenametext
Name.
Addressaddresstext
Address.
Address2address2text
Address2.
Citycitytext
City.
Statestatetext
State.
Countrycountrytext
Country.
Zipziptext
Zip.
Currencycurrencytext
Currency.
Ldap ouldap_outext
Ldap ou.
Manager idmanager_idnumber
Manager id.
Parent idparent_idnumber
Parent id.
Companycompany_idnumber
Company id.

Outputs

dataobject
The complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page cursor.
Example output
{
  "data": {},
  "has_more": false,
  "next_cursor": "example"
}

On this page