Snipe-IT API

https://snipe-it.readme.io/reference/
Admin
Snipe-IT is an open-source IT asset management system, and this documentation describes its JSON...
Tokens:268,074
Snippets:540
Trust Score:9.9
Update:3 months ago
Show doc for...
Tokens:
Raw
### Get Snipe-IT Version

Source: https://snipe-it.readme.io/reference/version

Fetches the current version and hash of the Snipe-IT installation.

```APIDOC
## GET /version

### Description
Fetches the current version and hash of the Snipe-IT you're running.

### Method
GET

### Endpoint
/version

### Responses
#### Success Response (200)
- **Result** (object) - An object containing version information.

#### Response Example
```json
{}
```
```

--------------------------------

### Install Passport

Source: https://snipe-it.readme.io/reference/generating-api-tokens

Run this command if you encounter errors when creating API tokens through the GUI. This installs the necessary Passport components.

```shell
php artisan passport:install
```

--------------------------------

### OpenAPI Definition for Fieldsets Fields Endpoint

Source: https://snipe-it.readme.io/reference/fieldsetsidfields

This OpenAPI definition describes the GET request for the /fieldsets/:id/fields endpoint, including parameters, responses, and example payloads.

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "snipe-it-rest-api",
    "version": "8.2.0"
  },
  "servers": [
    {
      "url": "https://develop.snipeitapp.com/api/v1"
    }
  ],
  "security": [
    {}
  ],
  "paths": {
    "/fieldsets/{id}/fields": {
      "get": {
        "summary": "/fieldsets/:id/fields",
        "description": "Return list of associated fields within a fieldset",
        "operationId": "fieldsetsidfields",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "The ID number of the fieldset",
            "schema": {
              "type": "integer",
              "format": "int32"
            },
            "required": true
          }
        ],
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n    \"total\": 3,\n    \"rows\": [\n        {\n            \"id\": 3,\n            \"name\": \"RAM\",\n            \"db_column_name\": \"_snipeit_ram_3\",\n            \"format\": \"ANY\",\n            \"field_values\": null,\n            \"field_values_array\": null,\n            \"type\": \"text\",\n            \"required\": 0,\n            \"created_at\": {\n                \"datetime\": \"2020-11-27 21:05:14\",\n                \"formatted\": \"Fri Nov 27, 2020 9:05PM\"\n            },\n            \"updated_at\": {\n                \"datetime\": \"2020-11-27 21:05:14\",\n                \"formatted\": \"Fri Nov 27, 2020 9:05PM\"\n            }\n        },\n        {\n            \"id\": 4,\n            \"name\": \"CPU\",\n            \"db_column_name\": \"_snipeit_cpu_4\",\n            \"format\": \"ANY\",\n            \"field_values\": null,\n            \"field_values_array\": null,\n            \"type\": \"text\",\n            \"required\": 0,\n            \"created_at\": {\n                \"datetime\": \"2020-11-27 21:05:14\",\n                \"formatted\": \"Fri Nov 27, 2020 9:05PM\"\n            },\n            \"updated_at\": {\n                \"datetime\": \"2020-11-27 21:05:14\",\n                \"formatted\": \"Fri Nov 27, 2020 9:05PM\"\n            }\n        },\n        {\n            \"id\": 5,\n            \"name\": \"MAC Address\",\n            \"db_column_name\": \"_snipeit_mac_address_5\",\n            \"format\": \"regex:/^([0-9a-fA-F]{2}[:-]){5}[0-9a-fA-F]{2}$/\",\n            \"field_values\": null,\n            \"field_values_array\": null,\n            \"type\": \"text\",\n            \"required\": 0,\n            \"created_at\": {\n                \"datetime\": \"2020-11-27 21:05:14\",\n                \"formatted\": \"Fri Nov 27, 2020 9:05PM\"\n            },\n            \"updated_at\": {\n                \"datetime\": \"2020-11-27 21:05:14\",\n                \"formatted\": \"Fri Nov 27, 2020 9:05PM\"\n            }\n        }\n    ]\n}"
                  },
                  "Not Found": {
                    "value": "{\n  \"status\": \"error\",\n  \"messages\": \"Fieldset not found\"\n}"
                  }
                },
                "schema": {
                  "oneOf": [
                    {
                      "type": "object",
                      "properties": {
                        "total": {
                          "type": "integer",
                          "example": 3,
                          "default": 0
                        },
                        "rows": {
                          "type": "array",
                          "items": {
                            "type": "object",
                            "properties": {
                              "id": {
                                "type": "integer",
                                "example": 3,
                                "default": 0
                              },
                              "name": {
                                "type": "string",
                                "example": "RAM"
                              },
                              "db_column_name": {
                                "type": "string",
                                "example": "_snipeit_ram_3"
                              },
                              "format": {
                                "type": "string",
                                "example": "ANY"
                              },
                              "field_values": {
                                "type": "null"
                              },
                              "field_values_array": {
                                "type": "null"
                              },
                              "type": {
                                "type": "string",
                                "example": "text"
                              },
                              "required": {
                                "type": "integer",
                                "example": 0,
                                "default": 0
                              },
                              "created_at": {
                                "type": "object",
                                "properties": {
                                  "datetime": {
                                    "type": "string",
                                    "example": "2020-11-27 21:05:14"
                                  },
                                  "formatted": {
                                    "type": "string",
                                    "example": "Fri Nov 27, 2020 9:05PM"
                                  }
                                }
                              },
                              "updated_at": {
                                "type": "object",
                                "properties": {
                                  "datetime": {
                                    "type": "string",
                                    "example": "2020-11-27 21:05:14"
                                  },
                                  "formatted": {
                                    "type": "string",
                                    "example": "Fri Nov 27, 2020 9:05PM"
                                  }
                                }
                              }
                            }
                          }
                        }
                      }
                    },
                    {
                      "type": "object",
                      "properties": {
                        "status": {
                          "type": "string",
                          "example": "error"
                        },
                        "messages": {
                          "type": "string",
                          "example": "Fieldset not found"
                        }
                      }
                    }
                  ]
                }
              }
            }
          }
        }
      }
    }
  }
}
```

--------------------------------

### List Hardware Asset Files (cURL)

Source: https://snipe-it.readme.io/reference/hardware-list-files

Use this cURL command to list all uploaded files for a given hardware asset ID. Ensure you replace 'your-snipe-it' with your Snipe-IT instance URL and '1' with the asset's ID. Include your API token in the Authorization header.

```curl
curl --request GET --url http://your-snipe-it/api/v1/hardware/1/files --header "Authorization: Bearer xxxxxxxxxx" --header 'accept: application/json' --verbose
```

--------------------------------

### API Authentication Headers Example (PHP)

Source: https://snipe-it.readme.io/reference/authenticating-with-the-api

Demonstrates how to set the required Accept, Content-Type, and Authorization headers, along with the recommended User-Agent, for an API request using the Guzzle library in PHP.

```php
$accessToken = 'MY-AWESOME-API-KEY';

$response = $client->request('GET', '/api/users', [
    'headers' => [
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
        'Authorization' => 'Bearer '.$accessToken,
        'User-Agent' => 'My Awesome Integration Script',
    ],
]);
```

--------------------------------

### OpenAPI Definition for Consumables by ID

Source: https://snipe-it.readme.io/reference/consumablesid

This OpenAPI 3.1.0 definition outlines the GET request for the /consumables/{id} endpoint. It specifies parameters, responses, and includes an example authorization header.

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "snipe-it-rest-api",
    "version": "8.2.0"
  },
  "servers": [
    {
      "url": "https://develop.snipeitapp.com/api/v1"
    }
  ],
  "security": [
    {}
  ],
  "paths": {
    "/consumables/{id}": {
      "get": {
        "summary": "/consumables/:id",
        "description": "Get the details on a consumable",
        "operationId": "consumablesid",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "integer",
              "format": "int32"
            },
            "required": true
          }
        ],
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {}
                }
              }
            }
          },
          "400": {
            "description": "400",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {}
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "x-readme": {
    "headers": [
      {
        "key": "Authorization",
        "value": "Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiIxIiwianRpIjoiY2Q1YmI1ZjEwNzg3YWM2NzUyZjc2NjYzNjYwNjVhYjg4MDllYWFjZGQzMjkxYWRhMTZiMTQ4N2Y2NjFlOTAwNDdlNWE4OGVhZjlhYzUyZTIiLCJpYXQiOjE3NTAyNzczNjkuNDExMDQ1LCJuYmYiOjE3NTAyNzczNjkuNDExMDQ5LCJleHAiOjIzODE0MjkzNjkuMzg5NDM1LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.JbGxp5PvAakXkSdD2xgKJOjgBZ-29A8N-JPyH-iiR3twUCFgKL-0XJTqvZ7h86BPDWGk6GBm9NfoQbcJ1BPGuQU_6uLFHDOwyzIhTgvCxsj4Jq6PanmpCkjfopThJYxiHRBCrilAgma_PVe-3clnEHSYwuOw-jaQQ-mWF_bNqWwfqv8Wui8Vi-LgaumZWANdFd-WGFvGwEKsrbbfq0r1i3HhyfsntJAqj_0oKEj_tDWAl8B4u-2EYdMcgISPlhptC2ZeZBJq6j57aVpn0ux_DwJcPU98J_6-iR48qAWaTZNpDalKPasx5mwlANH8lAkXH2rJNAIWoexNX1iKMBwevTnInVkBgwi5VNamueMRcpsOyeI5JKGyxtczCN2jFfiqGsDZcNTMs7PjaI74cPeSnqvQ9IVPoiZL8D91k2yWOszZKh5fkFtTUTWKHEFjhepr10LI8wy_V-oHgOcAcd3zYFc8rGoDUkMc6lMbLEC7nCGx3G3zqoZ3L-0D3xn59T8mW99F1twtOTc_QGSMhG5xM5zSypGYZ_HGt221iTskfR4JI7rHDMbsLnYpP5W4R48BErP2ylbmSK1VZCBL6cTIypJK8-zKtTD9vsFNRI3DCBpq2j1SrMyEAOEfLJkMWmGgQgDPC-tkjK3h4FTB_IyXVDnZ7_EmJdSjJT6Y6nFWME4"
      }
    ],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true
}
```

--------------------------------

### OpenAPI Definition for Group by ID

Source: https://snipe-it.readme.io/reference/groupsid

This OpenAPI 3.1.0 definition outlines the structure for the GET request to retrieve a group by its ID. It specifies parameters, responses, and includes an example authorization header.

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "snipe-it-rest-api",
    "version": "8.2.0"
  },
  "servers": [
    {
      "url": "https://develop.snipeitapp.com/api/v1"
    }
  ],
  "security": [
    {}
  ],
  "paths": {
    "/groups/{id}": {
      "get": {
        "summary": "/groups/:id",
        "description": "Return a group",
        "operationId": "groupsid",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "Group ID",
            "schema": {
              "type": "integer",
              "format": "int32"
            },
            "required": true
          }
        ],
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {}
                }
              }
            }
          },
          "400": {
            "description": "400",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {}
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "x-readme": {
    "headers": [
      {
        "key": "Authorization",
        "value": "Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiIxIiwianRpIjoiY2Q1YmI1ZjEwNzg3YWM2NzUyZjc2NjYzNjYwNjVhYjg4MDllYWFjZGQzMjkxYWRhMTZiMTQ4N2Y2NjFlOTAwNDdlNWE4OGVhZjlhYzUyZTIiLCJpYXQiOjE3NTAyNzczNjkuNDExMDQ1LCJuYmYiOjE3NTAyNzczNjkuNDExMDQ5LCJleHAiOjIzODE0MjkzNjkuMzg5NDM1LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.JbGxp5PvAakXkSdD2xgKJOjgBZ-29A8N-JPyH-iiR3twUCFgKL-0XJTqvZ7h86BPDWGk6GBm9NfoQbcJ1BPGuQU_6uLFHDOwyzIhTgvCxsj4Jq6PanmpCkjfopThJYxiHRBCrilAgma_PVe-3clnEHSYwuOw-jaQQ-mWF_bNqWwfqv8Wui8Vi-LgaumZWANdFd-WGFvGwEKsrbbfq0r1i3HhyfsntJAqj_0oKEj_tDWAl8B4u-2EYdMcgISPlhptC2ZeZBJq6j57aVpn0ux_DwJcPU98J_6-iR48qAWaTZNpDalKPasx5mwlANH8lAkXH2rJNAIWoexNX1iKMBwevTnInVkBgwi5VNamueMRcpsOyeI5JKGyxtczCN2jFfiqGsDZcNTMs7PjaI74cPeSnqvQ9IVPoiZL8D91k2yWOszZKh5fkFtTUTWKHEFjhepr10LI8wy_V-oHgOcAcd3zYFc8rGoDUkMc6lMbLEC7nCGx3G3zqoZ3L-0D3xn59T8mW99F1twtOTc_QGSMhG5xM5zSypGYZ_HGt221iTskfR4JI7rHDMbsLnYpP5W4R48BErP2ylbmSK1VZCBL6cTIypJK8-zKtTD9vsFNRI3DCBpq2j1SrMyEAOEfLJkMWmGgQgDPC-tkjK3h4FTB_IyXVDnZ7_EmJdSjJT6Y6nFWME4"
      }
    ]
  },
  "x-readme-fauxas": true
}
```

--------------------------------

### Create Personal API Client

Source: https://snipe-it.readme.io/reference/generating-api-tokens

Use this command to create a personal API client, which is required for generating API tokens. This is often used in conjunction with `passport:install`.

```shell
php artisan passport:client --personal
```

--------------------------------

### Successful Hardware Checkin Response

Source: https://snipe-it.readme.io/reference/hardware-checkin

This example shows a successful checkin response, detailing the asset's updated information.

```json
{
	"rows": [
		{
            "id": "45",
            "asset_tag": "976946724",
            "assigned_to": "",
            "category": "Reiciendis ea.",
            "companyName": "Williamson-Kuhn",
            "created_at": "",
            "eol": "1991-10-19",
            "expected_checkin": "",
            "image": "",
            "last_checkout": "",
            "location": "Expanded system",
            "manufacturer": "Farrell Group",
            "model": "Profound zero",
            "model_number": null,
            "name": "Programmable concept",
            "notes": "Ipsa pariatur sunt aut.",
            "order_number": "",
            "purchase_cost": "689.30",
            "purchase_date": "1991-09-19",
            "serial": "f5f06bb3-2420",
            "status_label": "Ready to Deploy"
            }
	],
}
```

--------------------------------

### OpenAPI Definition for View Manufacturer

Source: https://snipe-it.readme.io/reference/manufacturersid-1

This JSON snippet defines the OpenAPI specification for the GET request to retrieve a manufacturer by ID. It includes parameters, expected responses, and example data for success and error cases.

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "snipe-it-rest-api",
    "version": "8.2.0"
  },
  "servers": [
    {
      "url": "https://develop.snipeitapp.com/api/v1"
    }
  ],
  "security": [
    {}
  ],
  "paths": {
    "/manufacturers/{id}": {
      "get": {
        "summary": "/manufacturers/:id",
        "description": "View a manufacturer",
        "operationId": "manufacturersid-1",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "Manufacturer ID",
            "schema": {
              "type": "integer",
              "format": "int32"
            },
            "required": true
          }
        ],
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n  \"id\": 3,\n  \"name\": \"Rohan-Bergstrom\",\n  \"created_at\": \"2017-01-11 03:31:25\",\n  \"updated_at\": \"2017-01-11 03:31:25\"\n}"
                  },
                  "Not Found": {
                    "value": "{\n  \"status\": \"error\",\n  \"messages\": \"Company not found\"\n}"
                  }
                },
                "schema": {
                  "oneOf": [
                    {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "integer",
                          "example": 3,
                          "default": 0
                        },
                        "name": {
                          "type": "string",
                          "example": "Rohan-Bergstrom"
                        },
                        "created_at": {
                          "type": "string",
                          "example": "2017-01-11 03:31:25"
                        },
                        "updated_at": {
                          "type": "string",
                          "example": "2017-01-11 03:31:25"
                        }
                      }
                    },
                    {
                      "title": "Not Found",
                      "type": "object",
                      "properties": {
                        "status": {
                          "type": "string",
                          "example": "error"
                        },
                        "messages": {
                          "type": "string",
                          "example": "Company not found"
                        }
                      }
                    }
                  ]
                }
              }
            }
          },
          "401": {
            "description": "401",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n  \"status\": \"error\",\n  \"message\": \"Unauthorized.\"\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "example": "error"
                    },
                    "message": {
                      "type": "string",
                      "example": "Unauthorized."
                    }
                  }
                }
              }
            }
          },
          "405": {
            "description": "405",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n  \"status\": \"error\",\n  \"messages\": \"Method not allowed\"\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "example": "error"
                    },
                    "messages": {
                      "type": "string",
                      "example": "Method not allowed"
                    }
                  }
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "x-readme": {
    "headers": [
      {
        "key": "Authorization",
        "value": "Bearer YOUR_API_TOKEN"
      }
    ]
  }
}
```

--------------------------------

### OpenAPI Definition for Locations Endpoint

Source: https://snipe-it.readme.io/reference/locations-1

This JSON object defines the OpenAPI 3.1.0 specification for the /locations/{id} GET endpoint of the Snipe-IT API. It includes request parameters, response schemas, and example values.

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "snipe-it-rest-api",
    "version": "8.2.0"
  },
  "servers": [
    {
      "url": "https://develop.snipeitapp.com/api/v1"
    }
  ],
  "security": [
    {}
  ],
  "paths": {
    "/locations/{id}": {
      "get": {
        "summary": "/locations/:id",
        "description": "Get location details by id",
        "operationId": "locations-1",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "integer",
              "format": "int32"
            },
            "required": true
          }
        ],
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {}
                }
              }
            }
          },
          "400": {
            "description": "400",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {}
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "x-readme": {
    "headers": [
      {
        "key": "Authorization",
        "value": "Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiIxIiwianRpIjoiY2Q1YmI1ZjEwNzg3YWM2NzUyZjc2NjYzNjYwNjVhYjg4MDllYWFjZGQzMjkxYWRhMTZiMTQ4N2Y2NjFlOTAwNDdlNWE4OGVhZjlhYzUyZTIiLCJpYXQiOjE3NTAyNzczNjkuNDExMDQ1LCJuYmYiOjE3NTAyNzczNjkuNDExMDQ5LCJleHAiOjIzODE0MjkzNjkuMzg5NDM1LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.JbGxp5PvAakXkSdD2xgKJOjgBZ-29A8N-JPyH-iiR3twUCFgKL-0XJTqvZ7h86BPDWGk6GBm9NfoQbcJ1BPGuQU_6uLFHDOwyzIhTgvCxsj4Jq6PanmpCkjfopThJYxiHRBCrilAgma_PVe-3clnEHSYwuOw-jaQQ-mWF_bNqWwfqv8Wui8Vi-LgaumZWANdFd-WGFvGwEKsrbbfq0r1i3HhyfsntJAqj_0oKEj_tDWAl8B4u-2EYdMcgISPlhptC2ZeZBJq6j57aVpn0ux_DwJcPU98J_6-iR48qAWaTZNpDalKPasx5mwlANH8lAkXH2rJNAIWoexNX1iKMBwevTnInVkBgwi5VNamueMRcpsOyeI5JKGyxtczCN2jFfiqGsDZcNTMs7PjaI74cPeSnqvQ9IVPoiZL8D91k2yWOszZKh5fkFtTUTWKHEFjhepr10LI8wy_V-oHgOcAcd3zYFc8rGoDUkMc6lMbLEC7nCGx3G3zqoZ3L-0D3xn59T8mW99F1twtOTc_QGSMhG5xM5zSypGYZ_HGt221iTskfR4JI7rHDMbsLnYpP5W4R48BErP2ylbmSK1VZCBL6cTIypJK8-zKtTD9vsFNRI3DCBpq2j1SrMyEAOEfLJkMWmGgQgDPC-tkjK3h4FTB_IyXVDnZ7_EmJdSjJT6Y6nFWME4"
      }
    ],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true
}
```

--------------------------------

### Available Actions Example

Source: https://snipe-it.readme.io/reference/hardware-by-id

Specifies the boolean flags indicating which actions are available for an asset, such as checkout, checkin, clone, update, restore, and delete.

```json
{
  "available_actions": {
    "type": "object",
    "properties": {
      "checkout": {
        "type": "boolean",
        "example": true,
        "default": true
      },
      "checkin": {
        "type": "boolean",
        "example": true,
        "default": true
      },
      "clone": {
        "type": "boolean",
        "example": true,
        "default": true
      },
      "restore": {
        "type": "boolean",
        "example": false,
        "default": true
      },
      "update": {
        "type": "boolean",
        "example": true,
        "default": true
      },
      "delete": {
        "type": "boolean",
        "example": false,
        "default": true
      }
    }
  }
}
```

--------------------------------

### OpenAPI Definition for /licenses/{id}

Source: https://snipe-it.readme.io/reference/licensesid

This JSON object defines the OpenAPI 3.1.0 specification for the GET /licenses/{id} endpoint. It details the request parameters, expected responses, and the schema of a license object, including its properties and example values.

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "snipe-it-rest-api",
    "version": "8.2.0"
  },
  "servers": [
    {
      "url": "https://develop.snipeitapp.com/api/v1"
    }
  ],
  "security": [
    {}
  ],
  "paths": {
    "/licenses/{id}": {
      "get": {
        "summary": "/licenses/:id",
        "description": "",
        "operationId": "licensesid",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "The id (not name) of the license.",
            "schema": {
              "type": "integer",
              "format": "int32"
            },
            "required": true
          }
        ],
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n    \"id\": 1,\n    \"name\": \"Photoshop\",\n    \"company\": null,\n    \"manufacturer\": {\n        \"id\": 9,\n        \"name\": \"Adobe\"\n    },\n    \"product_key\": \"0d5254fb-b9f9-342c-a210-5feba9ea08b0\",\n    \"order_number\": \"27709963\",\n    \"purchase_order\": \"\",\n    \"purchase_date\": {\n        \"date\": \"2017-07-04\",\n        \"formatted\": \"2017-07-04\"\n    },\n    \"purchase_cost\": \"299.99\",\n    \"notes\": \"Created by DB seeder\",\n    \"expiration_date\": null,\n    \"seats\": 10,\n    \"free_seats_count\": 0,\n    \"license_name\": \"Prof. Alba Sawayn\",\n    \"license_email\": \"merlin50@example.org\",\n    \"maintained\": false,\n    \"supplier\": null,\n    \"created_at\": {\n        \"datetime\": \"2017-11-11 18:18:03\",\n        \"formatted\": \"2017-11-11 06:18 PM\"\n    },\n    \"updated_at\": {\n        \"datetime\": \"2017-11-11 18:18:03\",\n        \"formatted\": \"2017-11-11 06:18 PM\"\n    },\n    \"user_can_checkout\": false,\n    \"available_actions\": {\n        \"checkout\": true,\n        \"checkin\": true,\n        \"clone\": true,\n        \"update\": true,\n        \"delete\": true\n    }\n}"\n                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "integer",
                      "example": 1,
                      "default": 0
                    },
                    "name": {
                      "type": "string",
                      "example": "Photoshop"
                    },
                    "company": {},
                    "manufacturer": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "integer",
                          "example": 9,
                          "default": 0
                        },
                        "name": {
                          "type": "string",
                          "example": "Adobe"
                        }
                      }
                    },
                    "product_key": {
                      "type": "string",
                      "example": "0d5254fb-b9f9-342c-a210-5feba9ea08b0"
                    },
                    "order_number": {
                      "type": "string",
                      "example": "27709963"
                    },
                    "purchase_order": {
                      "type": "string",
                      "example": ""
                    },
                    "purchase_date": {
                      "type": "object",
                      "properties": {
                        "date": {
                          "type": "string",
                          "example": "2017-07-04"
                        },
                        "formatted": {
                          "type": "string",
                          "example": "2017-07-04"
                        }
                      }
                    },
                    "purchase_cost": {
                      "type": "string",
                      "example": "299.99"
                    },
                    "notes": {
                      "type": "string",
                      "example": "Created by DB seeder"
                    },
                    "expiration_date": {},
                    "seats": {
                      "type": "integer",
                      "example": 10,
                      "default": 0
                    },
                    "free_seats_count": {
                      "type": "integer",
                      "example": 0,
                      "default": 0
                    },
                    "license_name": {
                      "type": "string",
                      "example": "Prof. Alba Sawayn"
                    },
                    "license_email": {
                      "type": "string",
                      "example": "merlin50@example.org"
                    },
                    "maintained": {
                      "type": "boolean",
                      "example": false,
                      "default": false
                    },
                    "supplier": {},
                    "created_at": {
                      "type": "object",
                      "properties": {
                        "datetime": {
                          "type": "string",
                          "example": "2017-11-11 18:18:03"
                        },
                        "formatted": {
                          "type": "string",
                          "example": "2017-11-11 06:18 PM"
                        }
                      }
                    },
                    "updated_at": {
                      "type": "object",
                      "properties": {
                        "datetime": {
                          "type": "string",
                          "example": "2017-11-11 18:18:03"
                        },
                        "formatted": {
                          "type": "string",
                          "example": "2017-11-11 06:18 PM"
                        }
                      }
                    },
                    "user_can_checkout": {
                      "type": "boolean",
                      "example": false,
                      "default": false
                    },
                    "available_actions": {
                      "type": "object",
                      "properties": {
                        "checkout": {
                          "type": "boolean",
                          "example": true,
                          "default": false
                        },
                        "checkin": {
                          "type": "boolean",
                          "example": true,
                          "default": false
                        },
                        "clone": {
                          "type": "boolean",
                          "example": true,
                          "default": false
                        },
                        "update": {
                          "type": "boolean",
                          "example": true,
                          "default": false
                        },
                        "delete": {
                          "type": "boolean",
                          "example": true,
                          "default": false
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}
```

--------------------------------

### Example API Response for Licenses

Source: https://snipe-it.readme.io/reference/licenses

This JSON object represents a successful response (200 OK) from the licenses endpoint, detailing a list of software licenses with their associated information.

```json
{
    "total": 4,
    "rows": [
        {
            "id": 1,
            "name": "Photoshop",
            "company": null,
            "manufacturer": {
                "id": 9,
                "name": "Adobe"
            },
            "product_key": "0d5254fb-b9f9-342c-a210-5feba9ea08b0",
            "order_number": "27709963",
            "purchase_order": "",
            "purchase_date": {
                "date": "2017-07-04",
                "formatted": "2017-07-04"
            },
            "purchase_cost": "299.99",
            "notes": "Created by DB seeder",
            "expiration_date": null,
            "seats": 10,
            "free_seats_count": 10,
            "license_name": "Prof. Alba Sawayn",
            "license_email": "merlin50@example.org",
            "maintained": false,
            "supplier": null,
            "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
            }
        },
        {
            "id": 2,
            "name": "Acrobat",
            "company": null,
            "manufacturer": {
                "id": 9,
                "name": "Adobe"
            },
            "product_key": "fb382c35-4514-3c60-ab99-9fd2f7d492ea",
            "order_number": "30329422",
            "purchase_order": "",
            "purchase_date": {
                "date": "2017-01-15",
                "formatted": "2017-01-15"
            },
            "purchase_cost": "29.99",
            "notes": "Created by DB seeder",
            "expiration_date": null,
            "seats": 10,
            "free_seats_count": 10,
            "license_name": "Katelyn Boehm",
            "license_email": "beverly.hartmann@example.com",
            "maintained": false,
            "supplier": null,
            "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
            }
        },
        {
            "id": 3,
            "name": "InDesign",
            "company": null,
            "manufacturer": {
                "id": 9,
                "name": "Adobe"
            },
            "product_key": "5b8704bb-6948-3fd3-82df-ba344a5b10eb",
            "order_number": "23796169",
            "purchase_order": "",
            "purchase_date": {
                "date": "2017-08-14",
                "formatted": "2017-08-14"
            },
            "purchase_cost": "199.99",
            "notes": "Created by DB seeder",
            "expiration_date": null,
            "seats": 10,
            "free_seats_count": 10,
            "license_name": "Mrs. 
        }
    ]
}
```
Tokens:
Raw