snipe-it.readme.io
Open in
urlscan Pro
104.16.241.118
Public Scan
Submitted URL: https://snipe-it.readme.io/reference
Effective URL: https://snipe-it.readme.io/reference/api-overview
Submission: On April 18 via manual from US — Scanned from IT
Effective URL: https://snipe-it.readme.io/reference/api-overview
Submission: On April 18 via manual from US — Scanned from IT
Form analysis 0 forms found in the DOM
Text Content
Jump to Content
InstallationUser's ManualReleasesHostedPro SupportAPI Reference
GuidesAPI ReferenceChangelogv5.4.4v6.2.3v6.3.3v6.3.4
--------------------------------------------------------------------------------
InstallationUser's ManualReleasesHostedPro SupportAPI Reference
API Reference
v6.3.4
API Reference
Search
CTRL-K
Overview
All
Guides
Reference
Changelog
START TYPING TO SEARCH…
JUMP TOCTRL-/
API
* Overview
* Generating API Tokens
* API Permissions
* Authenticating With the API
* Testing in Postman
* Using the API Explorer
* API Throttling
* Power BI
ASSETS
* /hardwareget
* /hardwarepost
* /hardware/:idget
* /hardware/bytag/:asset_tagget
* /hardware/byserial/:serialget
* /hardware/:idput
* /hardware/:idpatch
* /hardware/:iddelete
* /hardware/:id/checkoutpost
* /hardware/:id/checkinpost
* /hardware/auditpost
* /hardware/:id/restorepost
* /hardware/audit/dueget
* /hardware/audit/overdueget
* /hardware/:id/licensesget
* Updating Custom Fields via API
CUSTOM FIELDS & FIELDSETS
* /fieldsget
* /fieldspost
* /fields/:idget
* /fields/:idput
* /fields/:idpatch
* /fields/:iddelete
* /fields/:id/associatepost
* /fields/:id/disassociatepost
* /fieldsetsget
* /fieldsetspost
* /fieldsets/:idget
* /fieldsets/:idput
* /fieldsets/:iddelete
* /fieldsets/:id/fieldsget
COMPANIES
* /companiesget
* /companiespost
* /companies/:idget
* /companies/:idput
* /companies/:idpatch
* /companies/:iddelete
LOCATIONS
* /locationsget
* /locationspost
* /locations/:idget
* /locations/:idput
* /locations/:idpatch
* /locations/:iddelete
ACCESSORIES
* /accessoriesget
* /accessoriespost
* /accessories/:idget
* /accessories/:idput
* /accessories/:idpatch
* /accessories/:iddelete
* /accessories/:id/checkedoutget
* /accessories/:id/checkinpost
* /accessories/:id/checkoutpost
CONSUMABLES
* /consumablesget
* /consumablespost
* /consumables/:idget
* /consumables/:idput
* /consumables/:idpatch
* /consumables/:iddelete
* /consumables/:id/checkoutpost
COMPONENTS
* /componentsget
* /componentspost
* /components/:idget
* /components/:idput
* /components/:idpatch
* /components/:iddelete
* /components/:id/assetsget
* /components/:id/checkoutpost
* /components/:id/checkinpost
USERS
* /usersget
* /userspost
* /users/:idget
* /users/:idpatch
* /users/:iddelete
* /users/:idput
* /users/:id/restorepost
* /users/:id/assetsget
* /users/:id/accessoriesget
* /users/:id/licensesget
* /users/meget
STATUS LABELS
* /statuslabelsget
* /statuslabelspost
* /statuslabels/:idget
* /statuslabels/:idput
* /statuslabels/:idpatch
* /statuslabels/:iddelete
* /statuslabels/:id/assetlistget
MODELS
* /modelsget
* /modelspost
* /models/:idget
* /models/:idput
* /models/:idpatch
* /models/:iddelete
LICENSES
* /licensesget
* /licenses/post
* /licenses/:idget
* /licenses/:idput
* /licenses/:idpatch
* /licenses/:iddelete
* /licenses/:id/seatsget
* /licenses/:id/seats/:seat_idget
* /licenses/:id/seats/:seat_idput
* /licenses/:id/seats/:seat_idpatch
CATEGORIES
* /categoriesget
* /categoriespost
* /categories/:idget
* /categories/:idput
* /categories/:idpatch
* /categories/:iddelete
MANUFACTURERS
* /manufacturersget
* /manufacturerspost
* /manufacturers/:idget
* /manufacturers/:idput
* /manufacturers/:idpatch
* /manufacturers/:iddelete
SUPPLIERS
* /suppliersget
* /suppliers/:idget
ASSET MAINTENANCES
* /maintenancesget
* /maintenancespost
* /maintenances/:idput
* /maintenances/:idpatch
* /maintenances/:iddelete
DEPARTMENTS
* /departmentsget
* /departmentspost
* /departments/:idget
* /departments/:idput
* /departments/:idpatch
* /departments/:iddelete
GROUPS
* /groupsget
* /groupspost
* /groups/:idget
* /groups/:idput
* /groups/:idpatch
* /groups/:iddelete
SETTINGS
* /settings/backupsget
* /settings/backups/download/:fileget
REPORTS
* /reports/activityget
Powered by
JUMP TOCTRL-/
API
* Overview
* Generating API Tokens
* API Permissions
* Authenticating With the API
* Testing in Postman
* Using the API Explorer
* API Throttling
* Power BI
ASSETS
* /hardwareget
* /hardwarepost
* /hardware/:idget
* /hardware/bytag/:asset_tagget
* /hardware/byserial/:serialget
* /hardware/:idput
* /hardware/:idpatch
* /hardware/:iddelete
* /hardware/:id/checkoutpost
* /hardware/:id/checkinpost
* /hardware/auditpost
* /hardware/:id/restorepost
* /hardware/audit/dueget
* /hardware/audit/overdueget
* /hardware/:id/licensesget
* Updating Custom Fields via API
CUSTOM FIELDS & FIELDSETS
* /fieldsget
* /fieldspost
* /fields/:idget
* /fields/:idput
* /fields/:idpatch
* /fields/:iddelete
* /fields/:id/associatepost
* /fields/:id/disassociatepost
* /fieldsetsget
* /fieldsetspost
* /fieldsets/:idget
* /fieldsets/:idput
* /fieldsets/:iddelete
* /fieldsets/:id/fieldsget
COMPANIES
* /companiesget
* /companiespost
* /companies/:idget
* /companies/:idput
* /companies/:idpatch
* /companies/:iddelete
LOCATIONS
* /locationsget
* /locationspost
* /locations/:idget
* /locations/:idput
* /locations/:idpatch
* /locations/:iddelete
ACCESSORIES
* /accessoriesget
* /accessoriespost
* /accessories/:idget
* /accessories/:idput
* /accessories/:idpatch
* /accessories/:iddelete
* /accessories/:id/checkedoutget
* /accessories/:id/checkinpost
* /accessories/:id/checkoutpost
CONSUMABLES
* /consumablesget
* /consumablespost
* /consumables/:idget
* /consumables/:idput
* /consumables/:idpatch
* /consumables/:iddelete
* /consumables/:id/checkoutpost
COMPONENTS
* /componentsget
* /componentspost
* /components/:idget
* /components/:idput
* /components/:idpatch
* /components/:iddelete
* /components/:id/assetsget
* /components/:id/checkoutpost
* /components/:id/checkinpost
USERS
* /usersget
* /userspost
* /users/:idget
* /users/:idpatch
* /users/:iddelete
* /users/:idput
* /users/:id/restorepost
* /users/:id/assetsget
* /users/:id/accessoriesget
* /users/:id/licensesget
* /users/meget
STATUS LABELS
* /statuslabelsget
* /statuslabelspost
* /statuslabels/:idget
* /statuslabels/:idput
* /statuslabels/:idpatch
* /statuslabels/:iddelete
* /statuslabels/:id/assetlistget
MODELS
* /modelsget
* /modelspost
* /models/:idget
* /models/:idput
* /models/:idpatch
* /models/:iddelete
LICENSES
* /licensesget
* /licenses/post
* /licenses/:idget
* /licenses/:idput
* /licenses/:idpatch
* /licenses/:iddelete
* /licenses/:id/seatsget
* /licenses/:id/seats/:seat_idget
* /licenses/:id/seats/:seat_idput
* /licenses/:id/seats/:seat_idpatch
CATEGORIES
* /categoriesget
* /categoriespost
* /categories/:idget
* /categories/:idput
* /categories/:idpatch
* /categories/:iddelete
MANUFACTURERS
* /manufacturersget
* /manufacturerspost
* /manufacturers/:idget
* /manufacturers/:idput
* /manufacturers/:idpatch
* /manufacturers/:iddelete
SUPPLIERS
* /suppliersget
* /suppliers/:idget
ASSET MAINTENANCES
* /maintenancesget
* /maintenancespost
* /maintenances/:idput
* /maintenances/:idpatch
* /maintenances/:iddelete
DEPARTMENTS
* /departmentsget
* /departmentspost
* /departments/:idget
* /departments/:idput
* /departments/:idpatch
* /departments/:iddelete
GROUPS
* /groupsget
* /groupspost
* /groups/:idget
* /groups/:idput
* /groups/:idpatch
* /groups/:iddelete
SETTINGS
* /settings/backupsget
* /settings/backups/download/:fileget
REPORTS
* /reports/activityget
Powered by
OVERVIEW
The Snipe-IT JSON REST API allows you to perform most of the same actions
through your own tools as you can through the web interface.
If you need the Swagger/OpenAPI Specification, you can find it here.
> 🚧
>
> TRY THE API EXPLORER
>
> In this documentation, whenever you see the API explorer with a button say
> thats "Try It", go ahead and try it! The API explorer live-queries a demo
> database attached to the development demo. You'll be able to add, edit, update
> and delete right from the API explorer.
Since the API Explorer talks to the live development database - and resets
periodically - you CAN (and probably) will occasionally break some stuff as
you're playing around.
If you'd like to be logged into the development demo at the same time as you
play with the API Explorer to see your changes reflect through the Web UI, use
the username admin and the password password.
This documentation (and the API itself) is still under development, so some
things may not work exactly as expected, or we may not have code examples and
sample responses for everything just yet. Please be patient. As we continue to
develop the API, we are updating the documentation.
PHILOSOPHY
Our philosophy on HTTP status codes is that as long as the pipe (the http
request itself) is sound, the API should return a 200 OK status code. We realize
that some very smart people have a very different philosophy, but in general we
want the HTTP status code to describe the state of the resource endpoint, with
the actual status of the transaction returned in the JSON payload.
For example, if you made a valid HTTP request to retrieve an asset that doesn't
exist, we'll return a 200 OK, with the following payload:
200 OK JSON Response
{
"status": "error",
"messages": "Asset does not exist."
}
Likewise, if you try to update a resource, but you don't provide all of the
required information, we'll respond with validation errors in the messages
section of the response:
JSON
{
"status": "error",
"messages": {
"model_id": [
"The selected model id is invalid."
],
"status_id": [
"The selected status id is invalid."
]
}
}
Updated almost 3 years ago
--------------------------------------------------------------------------------
Generating API Tokens
Did this page help you?
Yes
No
Updated almost 3 years ago
--------------------------------------------------------------------------------
Generating API Tokens
Did this page help you?
Yes
No
1. API
2. Overview
3. Generating API Tokens
4. API Permissions
5. Authenticating With the API
6. Testing in Postman
7. Using the API Explorer
8. API Throttling
9. Power BI
1. Assets
2. /hardwareget
3. /hardware/:id/licensesget
4. /hardware/audit/overdueget
5. /hardware/audit/dueget
6. /hardware/:id/restorepost
7. /hardware/auditpost
8. /hardware/:id/checkinpost
9. /hardware/:id/checkoutpost
10. /hardware/:iddelete
11. /hardware/:idpatch
12. /hardware/:idput
13. /hardware/byserial/:serialget
14. /hardware/bytag/:asset_tagget
15. /hardware/:idget
16. /hardwarepost
17. Updating Custom Fields via API
1. Custom Fields & Fieldsets
2. /fieldsget
3. /fields/:id/disassociatepost
4. /fields/:id/associatepost
5. /fields/:iddelete
6. /fields/:idpatch
7. /fields/:idput
8. /fields/:idget
9. /fieldspost
10. /fieldsetsget
11. /fieldsets/:id/fieldsget
12. /fieldsets/:iddelete
13. /fieldsets/:idput
14. /fieldsets/:idget
15. /fieldsetspost
1. Companies
2. /companiesget
3. /companies/:iddelete
4. /companies/:idpatch
5. /companies/:idput
6. /companies/:idget
7. /companiespost
1. Locations
2. /locationsget
3. /locations/:iddelete
4. /locations/:idpatch
5. /locations/:idput
6. /locations/:idget
7. /locationspost
1. Accessories
2. /accessoriesget
3. /accessories/:id/checkoutpost
4. /accessories/:id/checkinpost
5. /accessories/:id/checkedoutget
6. /accessories/:iddelete
7. /accessories/:idpatch
8. /accessories/:idput
9. /accessories/:idget
10. /accessoriespost
1. Consumables
2. /consumablesget
3. /consumables/:id/checkoutpost
4. /consumables/:iddelete
5. /consumables/:idpatch
6. /consumables/:idput
7. /consumables/:idget
8. /consumablespost
1. Components
2. /componentsget
3. /components/:id/checkinpost
4. /components/:id/checkoutpost
5. /components/:id/assetsget
6. /components/:iddelete
7. /components/:idpatch
8. /components/:idput
9. /components/:idget
10. /componentspost
1. Users
2. /usersget
3. /users/meget
4. /users/:id/licensesget
5. /users/:id/accessoriesget
6. /users/:id/assetsget
7. /users/:id/restorepost
8. /users/:idput
9. /users/:iddelete
10. /users/:idpatch
11. /users/:idget
12. /userspost
1. Status Labels
2. /statuslabelsget
3. /statuslabels/:id/assetlistget
4. /statuslabels/:iddelete
5. /statuslabels/:idpatch
6. /statuslabels/:idput
7. /statuslabels/:idget
8. /statuslabelspost
1. Models
2. /modelsget
3. /models/:iddelete
4. /models/:idpatch
5. /models/:idput
6. /models/:idget
7. /modelspost
1. Licenses
2. /licensesget
3. /licenses/:id/seats/:seat_idpatch
4. /licenses/:id/seats/:seat_idput
5. /licenses/:id/seats/:seat_idget
6. /licenses/:id/seatsget
7. /licenses/:iddelete
8. /licenses/:idpatch
9. /licenses/:idput
10. /licenses/:idget
11. /licenses/post
1. Categories
2. /categoriesget
3. /categories/:iddelete
4. /categories/:idpatch
5. /categories/:idput
6. /categories/:idget
7. /categoriespost
1. Manufacturers
2. /manufacturersget
3. /manufacturers/:iddelete
4. /manufacturers/:idpatch
5. /manufacturers/:idput
6. /manufacturers/:idget
7. /manufacturerspost
1. Suppliers
2. /suppliersget
3. /suppliers/:idget
1. Asset Maintenances
2. /maintenancesget
3. /maintenances/:iddelete
4. /maintenances/:idpatch
5. /maintenances/:idput
6. /maintenancespost
1. Departments
2. /departmentsget
3. /departments/:iddelete
4. /departments/:idpatch
5. /departments/:idput
6. /departments/:idget
7. /departmentspost
1. Groups
2. /groupsget
3. /groups/:iddelete
4. /groups/:idpatch
5. /groups/:idput
6. /groups/:idget
7. /groupspost
1. Settings
2. /settings/backupsget
3. /settings/backups/download/:fileget
1. Reports
2. /reports/activityget
1. API
2. Overview
3. Generating API Tokens
4. API Permissions
5. Authenticating With the API
6. Testing in Postman
7. Using the API Explorer
8. API Throttling
9. Power BI
1. Assets
2. /hardwareget
3. /hardware/:id/licensesget
4. /hardware/audit/overdueget
5. /hardware/audit/dueget
6. /hardware/:id/restorepost
7. /hardware/auditpost
8. /hardware/:id/checkinpost
9. /hardware/:id/checkoutpost
10. /hardware/:iddelete
11. /hardware/:idpatch
12. /hardware/:idput
13. /hardware/byserial/:serialget
14. /hardware/bytag/:asset_tagget
15. /hardware/:idget
16. /hardwarepost
17. Updating Custom Fields via API
1. Custom Fields & Fieldsets
2. /fieldsget
3. /fields/:id/disassociatepost
4. /fields/:id/associatepost
5. /fields/:iddelete
6. /fields/:idpatch
7. /fields/:idput
8. /fields/:idget
9. /fieldspost
10. /fieldsetsget
11. /fieldsets/:id/fieldsget
12. /fieldsets/:iddelete
13. /fieldsets/:idput
14. /fieldsets/:idget
15. /fieldsetspost
1. Companies
2. /companiesget
3. /companies/:iddelete
4. /companies/:idpatch
5. /companies/:idput
6. /companies/:idget
7. /companiespost
1. Locations
2. /locationsget
3. /locations/:iddelete
4. /locations/:idpatch
5. /locations/:idput
6. /locations/:idget
7. /locationspost
1. Accessories
2. /accessoriesget
3. /accessories/:id/checkoutpost
4. /accessories/:id/checkinpost
5. /accessories/:id/checkedoutget
6. /accessories/:iddelete
7. /accessories/:idpatch
8. /accessories/:idput
9. /accessories/:idget
10. /accessoriespost
1. Consumables
2. /consumablesget
3. /consumables/:id/checkoutpost
4. /consumables/:iddelete
5. /consumables/:idpatch
6. /consumables/:idput
7. /consumables/:idget
8. /consumablespost
1. Components
2. /componentsget
3. /components/:id/checkinpost
4. /components/:id/checkoutpost
5. /components/:id/assetsget
6. /components/:iddelete
7. /components/:idpatch
8. /components/:idput
9. /components/:idget
10. /componentspost
1. Users
2. /usersget
3. /users/meget
4. /users/:id/licensesget
5. /users/:id/accessoriesget
6. /users/:id/assetsget
7. /users/:id/restorepost
8. /users/:idput
9. /users/:iddelete
10. /users/:idpatch
11. /users/:idget
12. /userspost
1. Status Labels
2. /statuslabelsget
3. /statuslabels/:id/assetlistget
4. /statuslabels/:iddelete
5. /statuslabels/:idpatch
6. /statuslabels/:idput
7. /statuslabels/:idget
8. /statuslabelspost
1. Models
2. /modelsget
3. /models/:iddelete
4. /models/:idpatch
5. /models/:idput
6. /models/:idget
7. /modelspost
1. Licenses
2. /licensesget
3. /licenses/:id/seats/:seat_idpatch
4. /licenses/:id/seats/:seat_idput
5. /licenses/:id/seats/:seat_idget
6. /licenses/:id/seatsget
7. /licenses/:iddelete
8. /licenses/:idpatch
9. /licenses/:idput
10. /licenses/:idget
11. /licenses/post
1. Categories
2. /categoriesget
3. /categories/:iddelete
4. /categories/:idpatch
5. /categories/:idput
6. /categories/:idget
7. /categoriespost
1. Manufacturers
2. /manufacturersget
3. /manufacturers/:iddelete
4. /manufacturers/:idpatch
5. /manufacturers/:idput
6. /manufacturers/:idget
7. /manufacturerspost
1. Suppliers
2. /suppliersget
3. /suppliers/:idget
1. Asset Maintenances
2. /maintenancesget
3. /maintenances/:iddelete
4. /maintenances/:idpatch
5. /maintenances/:idput
6. /maintenancespost
1. Departments
2. /departmentsget
3. /departments/:iddelete
4. /departments/:idpatch
5. /departments/:idput
6. /departments/:idget
7. /departmentspost
1. Groups
2. /groupsget
3. /groups/:iddelete
4. /groups/:idpatch
5. /groups/:idput
6. /groups/:idget
7. /groupspost
1. Settings
2. /settings/backupsget
3. /settings/backups/download/:fileget
1. Reports
2. /reports/activityget