SNsnipeitapp

/licenses

Changed on

Return a listing of licenses

get/licenses

Request

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

Query parameters

namestring
product_keystring
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)

purchase_orderstring
license_namestring

Name of the person on the license

license_emailstring

Email address associated with license

manufacturer_idinteger

Manufacturer ID

supplier_idinteger

Supplier ID

category_idinteger

Category ID

depreciation_idinteger

Depreciation ID

maintainedboolean

true / false

deletedstring

Set to true to return deleted licenses

Response

200

totalinteger

Example response

{
  "total": 4,
  "rows": [
    {
      "id": 1,
      "name": "Photoshop",
      "manufacturer": {
        "id": 9,
        "name": "Adobe"
      },
      "product_key": "0d5254fb-b9f9-342c-a210-5feba9ea08b0",
      "order_number": "27709963",
      "purchase_date": {
        "date": "2017-07-04",
        "formatted": "2017-07-04"
      },
      "purchase_cost": "299.99",
      "notes": "Created by DB seeder",
      "seats": 10,
      "free_seats_count": 10,
      "license_name": "Prof. Alba Sawayn",
      "license_email": "merlin50@example.org",
      "created_at": {
        "datetime": "2017-11-11 18:18:03",
        "formatted": "2017-11-11 06:18 PM"
      },
      "updated_at": {
        "datetime": "2017-11-11 18:18:03",
        "formatted": "2017-11-11 06:18 PM"
      },
      "user_can_checkout": true,
      "available_actions": {
        "checkout": true,
        "checkin": true,
        "clone": true,
        "update": true,
        "delete": true
      }
    }
  ]
}

Changes