Snipe-IT
App · 25 actions
Manage Snipe-IT assets, companies and locations and check assets in and out.
Actions
| Action | What it does |
|---|---|
| Check in asset | Check in asset. |
| Check out asset | Check out asset. |
| Create asset | Create asset. |
| Create company | Create company. |
| Create location | Create location. |
| Delete asset | Delete asset. |
| Delete company | Delete company. |
| Delete location | Delete location. |
| Get asset | Get asset. |
| Get asset model | Get asset model. |
| Get company | Get company. |
| Get location | Get location. |
| Get status label | Get status label. |
| Get user | Get user. |
| List asset models | List asset models. |
| List assets | List assets. |
| List categories | List categories. |
| List companies | List companies. |
| List locations | List locations. |
| List manufacturers | List manufacturers. |
| List status labels | List status labels. |
| List users | List users. |
| Update asset | Update asset. |
| Update company | Update company. |
| Update location | Update location. |
Check in asset
Check in asset. Returns the service response.
Inputs
- Id
idnumberRequired - Id.
- Status
status_idnumberRequired - Status id.
- Name
nametext - Name.
- Note
notetext - Note.
- Location
location_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
- Id
idnumberRequired - Id.
- Status
status_idnumberRequired - Status id.
- Checkout to type
checkout_to_typetextRequired - Checkout to type.One of:
user,asset,location. - Assigned user
assigned_usernumber - Assigned user.
- Assigned asset
assigned_assetnumber - Assigned asset.
- Assigned location
assigned_locationnumber - Assigned location.
- Expected checkin
expected_checkindate - Expected checkin.
- Checkout at
checkout_atdate - Checkout at.
- Name
nametext - Name.
- Note
notetext - 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 tag
asset_tagtextRequired - Asset tag.
- Status
status_idnumberRequired - Status id.
- Model
model_idnumberRequired - Model id.
- Name
nametext - Name.
- Image
imagetext - Image.
- Serial
serialtext - Serial.
- Purchase date
purchase_datedate - Purchase date.
- Purchase cost
purchase_costnumber - Purchase cost.
- Order number
order_numbertext - Order number.
- Notes
notestext - Notes.
- Archived
archivedtrue/false - Archived.
- Warranty months
warranty_monthsnumber - Warranty months.
- Depreciate
depreciatetrue/false - Depreciate.
- Supplier id
supplier_idnumber - Supplier id.
- Requestable
requestabletrue/false - Requestable.
- Rtd location id
rtd_location_idnumber - Rtd location id.
- Last audit date
last_audit_datedate - Last audit date.
- Location
location_idnumber - Location id.
- Byod
byodtrue/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
- Name
nametextRequired - 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
- Name
nametextRequired - Name.
- Address
addresstext - Address.
- Address2
address2text - Address2.
- City
citytext - City.
- State
statetext - State.
- Country
countrytext - Country.
- Zip
ziptext - Zip.
- Ldap ou
ldap_outext - Ldap ou.
- Parent id
parent_idnumber - Parent id.
- Currency
currencytext - Currency.
- Manager id
manager_idnumber - Manager id.
- Company
company_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
- Id
idnumberRequired - 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
- Id
idnumberRequired - 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
- Id
idnumberRequired - 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
- Id
idnumberRequired - 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
- Id
idnumberRequired - 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
- Id
idnumberRequired - 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
- Id
idnumberRequired - 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
- Id
idnumberRequired - 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
- Id
idnumberRequired - 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
- Limit
limitnumber - Limit.
- Offset
offsetnumber - Offset.At least 0.
- Search
searchtext - Search.
- Sort
sorttext - Sort.
- Order
ordertext - Order.One of:
asc,desc. - Name
nametext - Name.
- Notes
notestext - Notes.
- Model number
model_numbertext - Model number.
- Category id
category_idnumber - Category id.
- Depreciation id
depreciation_idnumber - Depreciation id.
- Requestable
requestabletrue/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
- Limit
limitnumber - Limit.
- Offset
offsetnumber - Offset.At least 0.
- Search
searchtext - Search.
- Order number
order_numbertext - Order number.
- Sort
sorttext - Sort.
- Order
ordertext - Order.One of:
asc,desc. - Model
model_idnumber - Model id.
- Category id
category_idnumber - Category id.
- Manufacturer id
manufacturer_idnumber - Manufacturer id.
- Company
company_idnumber - Company id.
- Location
location_idnumber - Location id.
- Status
statustext - Status.
- Status
status_idnumber - Status id.
- Assigned to
assigned_tonumber - Assigned to.
- Assigned type
assigned_typetext - Assigned type.One of:
App\Models\Asset,App\Models\Accessory,App\Models\User. - Filter
filtertext - 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
- Name
nametext - Name.
- Limit
limitnumber - Limit.
- Offset
offsetnumber - Offset.At least 0.
- Search
searchtext - Search.
- Sort
sorttext - Sort.
- Order
ordertext - Order.One of:
asc,desc. - Category id
category_idnumber - Category id.
- Category type
category_typetext - Category type.One of:
asset,accessory,consumable,component,license. - Use default eula
use_default_eulatrue/false - Use default eula.
- Require acceptance
require_acceptancetrue/false - Require acceptance.
- Checkin email
checkin_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
- Name
nametext - 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
- Name
nametext - Name.
- Limit
limitnumber - Limit.
- Offset
offsetnumber - Offset.At least 0.
- Search
searchtext - Search.
- Sort
sorttext - Sort.
- Order
ordertext - Order.One of:
asc,desc. - Address
addresstext - Address.
- Address2
address2text - Address2.
- City
citytext - City.
- Zip
ziptext - Zip.
- Country
countrytext - 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
- Name
nametext - Name.
- Url
urltext - Url.
- Support url
support_urltext - Support url.
- Support phone
support_phonetext - Support phone.
- Support email
support_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
- Name
nametext - Name.
- Limit
limitnumber - Limit.
- Offset
offsetnumber - Offset.At least 0.
- Search
searchtext - Search.
- Sort
sorttext - Sort.
- Order
ordertext - Order.One of:
asc,desc. - Status type
status_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
- Search
searchtext - Search.
- Limit
limitnumber - Limit.
- Offset
offsetnumber - Offset.At least 0.
- Sort
sorttext - Sort.
- Order
ordertext - Order.One of:
asc,desc. - First name
first_nametext - First name.
- Last name
last_nametext - Last name.
- Username
usernametext - Username.
- Email
emailtext - Email.
- Employee num
employee_numtext - Employee num.
- State
statetext - State.
- Zip
ziptext - Zip.
- Country
countrytext - Country.
- Group id
group_idnumber - Group id.
- Department id
department_idnumber - Department id.
- Company
company_idnumber - Company id.
- Location
location_idnumber - Location id.
- Deleted
deletedtrue/false - Deleted.
- All
alltrue/false - All.
- Ldap import
ldap_importtrue/false - Ldap import.
- Assets count
assets_countnumber - Assets count.
- Licenses count
licenses_countnumber - Licenses count.
- Accessories count
accessories_countnumber - Accessories count.
- Consumables count
consumables_countnumber - Consumables count.
- Remote
remotetrue/false - Remote.
- Vip
viptrue/false - Vip.
- Start date
start_datedate - Start date.
- End date
end_datedate - End date.
- Filter
filtertext - 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
- Id
idnumberRequired - Id.
- Asset tag
asset_tagtext - Asset tag.
- Notes
notestext - Notes.
- Status
status_idnumber - Status id.
- Model
model_idnumber - Model id.
- Last checkout
last_checkoutdate - Last checkout.
- Assigned user
assigned_usernumber - Assigned user.
- Assigned location
assigned_locationnumber - Assigned location.
- Assigned asset
assigned_assetnumber - Assigned asset.
- Company
company_idnumber - Company id.
- Serial
serialtext - Serial.
- Order number
order_numbertext - Order number.
- Warranty months
warranty_monthsnumber - Warranty months.
- Purchase cost
purchase_costnumber - Purchase cost.
- Purchase date
purchase_datedate - Purchase date.
- Requestable
requestabletrue/false - Requestable.
- Archived
archivedtrue/false - Archived.
- Rtd location id
rtd_location_idnumber - Rtd location id.
- Name
nametext - Name.
- Location
location_idtext - Location id.
- Byod
byodnumber - 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
- Id
idnumberRequired - Id.
- Name
nametextRequired - 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
- Id
idnumberRequired - Id.
- Name
nametext - Name.
- Address
addresstext - Address.
- Address2
address2text - Address2.
- City
citytext - City.
- State
statetext - State.
- Country
countrytext - Country.
- Zip
ziptext - Zip.
- Currency
currencytext - Currency.
- Ldap ou
ldap_outext - Ldap ou.
- Manager id
manager_idnumber - Manager id.
- Parent id
parent_idnumber - Parent id.
- Company
company_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"
}