---
title: "List images"
method: GET
path: "/v1/firearms/{id}/images"
tags: ["Firearms"]
---

# List images

`GET /v1/firearms/{id}/images`

## Request

- Base URL: `https://api.gunspec.io`
- URL: `https://api.gunspec.io/v1/firearms/{id}/images`
- Auth: one of:
  - API key in header `X-API-Key`
  - HTTP bearer

Returns every image associated with a firearm, with credits and licensing.

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

## Path parameters

- `id` string, required

## Response `200`

List images

- object
  - `success` boolean, required: Always true on a successful response. Every error carries `false` and an `error` object instead.
  - `data` FirearmImage[], required: The response payload.
    - `id` integer: Autoincrementing image id. Numeric, unlike the catalog slugs.
    - `firearmId` string: Slug of the firearm this row belongs to.
    - `url` string: Absolute, directly fetchable URL.
    - `type` 'svg' | 'photo' | '3d_model' | 'gallery' | 'primary' | 'thumbnail' | 'render' | 'profile' | 'angle' | 'detail': The storage label on `FirearmImage.type`, predating `kind`: `svg` is `silhouette`, `3d_model` is `model`, and `gallery` is the default an upload lands on. Branch on `kind`.
    - `source` string, nullable: Where the record came from: a curated entry, an inference, or an import.
    - `license` string, nullable: Licence the asset is held under, where one is recorded.
    - `kind` 'silhouette' | 'render' | 'photo' | 'schematic' | 'model': What kind of asset a media row is.
    - `storage` string, nullable: Where the bytes live: `cdn` for a static path, `r2` for an upload we serve.
    - `author` string, nullable: Who made the asset, where it is credited.
    - `sourceUrl` string, nullable: Page the asset or document was taken from.
    - `alt` string, nullable: Alt text, where one has been written. Null otherwise, so do not render an empty string.
    - `width` integer, nullable: Pixel width, where it is known.
    - `height` integer, nullable: Pixel height, where it is known.
    - `sortOrder` integer: Position within its list, ascending.

## Other responses

- `400`: Validation error
- `401`: Missing or invalid API key
- `403`: The credential is valid and the caller is not permitted. Three causes, none of which reissuing a key changes: the plan is below the endpoint's tier, the account is suspended, or the key is not attached to the thing being acted on, meaning a user account for `/v1/me` or a shop for `/v1/vendor`. Distinct from 401, which means the credential is missing, malformed or expired and a new one can work.
- `404`: Resource not found
- `429`: A limit was reached. `RATE_LIMITED` is the per-minute limit: wait `Retry-After` seconds (a minute) and retry. `DAILY_CAP_EXCEEDED` is the plan's daily limit, per key: nothing will be served until the counters return to zero at midnight UTC. `MONTHLY_CAP_EXCEEDED` is the plan's monthly allowance, for the whole account: nothing will be served until midnight UTC on the first of next month, or until the plan changes. For both, `Retry-After` is the seconds until then and `error.resetsAt` says when as an instant. Calls made after a refusal are refused too and do not spend the month, and a free key that keeps calling is paused, so stop at the first one and resume at the reset.
- `500`: Internal server error

---

[API](https://skmtc.dev/gunspec/apis/gunspec-io-api.md) · [All operations](https://skmtc.dev/gunspec/apis/gunspec-io-api/llms.txt) · [OpenAPI document](https://skmtc.dev/gunspec/apis/gunspec-io-api/revisions/f2e974d8b05c?raw)