SNsnipeitapp

/components

Changed on

Return a listing of components

get/components

Request

  • Base URL
    https://develop.snipeitapp.com/api/v1
  • URL
    https://develop.snipeitapp.com/api/v1/components
  • Auth
    none required

Query parameters

namestring
limitinteger

Specify the number of results you wish to return

offsetinteger

Offset to use

searchstring

A text string to search the assets data for

order_numberstring

Return only assets associated with a specific order number

sortstring

Specify the column name you wish to sort by

orderstring

Specify the order (asc or desc) you wish to order by on your sort column

expandstring

Whether to include detailed information on categories, etc (true) or just the text name (false)

Response

200

totalinteger

Example response

{
  "total": 4,
  "rows": [
    {
      "id": 1,
      "name": "Crucial 4GB DDR3L-1600 SODIMM",
      "location": {
        "id": 3,
        "name": "Nikitaborough"
      },
      "qty": 10,
      "min_amt": 2,
      "category": {
        "id": 13,
        "name": "RAM"
      },
      "order_number": "48349590",
      "purchase_date": {
        "date": "2017-11-28",
        "formatted": "2017-11-28"
      },
      "purchase_cost": "2.45",
      "remaining": 10,
      "company": {
        "id": 2,
        "name": "Hagenes, Kulas and Rutherford"
      },
      "created_at": {
        "datetime": "2018-10-09 19:09:21",
        "formatted": "2018-10-09 07:09 PM"
      },
      "updated_at": {
        "datetime": "2018-10-09 19:09:21",
        "formatted": "2018-10-09 07:09 PM"
      },
      "user_can_checkout": 1,
      "available_actions": {
        "checkout": true,
        "checkin": true,
        "update": true,
        "delete": true
      }
    }
  ]
}

Changes