List categories

Returns every firearm category that holds at least one firearm. Empty categories are omitted.

Available on every plan. Requires an API key; Explorer keys receive a reduced field set.

get/v1/categories

Request

Base URL: https://api.gunspec.io
URL: https://api.gunspec.io/v1/categories
Auth: one of:
- API key in header X-API-Key
- HTTP bearer

Headers

If-None-Matchstring

The ETag from a previous response. If the body would be byte-identical, the API answers 304 Not Modified with no body. A 304 counts toward the per-minute rate limit but not the daily request allowance.

Response

List categories

successboolean required

Always true on a successful response. Every error carries false and an error object instead.

Example response

{
  "success": true,
  "data": [
    {
      "id": "pistol",
      "name": "Pistol",
      "description": "Handguns designed to be fired with one or two hands"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.