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

# List schematics

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

## Request

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

Returns exploded-view and technical schematic drawings for a firearm.

**Requires Studio tier or higher.**

## Path parameters

- `id` string, required

## Response `200`

List schematics

- object
  - `success` boolean, required: Always true on a successful response. Every error carries `false` and an `error` object instead.
  - `data` FirearmSchematic[], required: The response payload.
    - `id` integer, required: Autoincrementing schematic id.
    - `firearmId` string, required: Slug of the firearm this row belongs to.
    - `title` string, required: What the document is called.
    - `type` 'blueprint' | 'spec_sheet' | 'manual' | 'datasheet' | 'exploded_view' | 'reference', required: What a schematic document is.
    - `url` string, required: Absolute, directly fetchable URL.
    - `format` string, nullable: File format, e.g. `pdf`.
    - `version` string, nullable: Revision of the document, where the publisher versions it.
    - `manufacturer` string, nullable: Publisher of the document, often but not always the maker.
    - `source` string, nullable: Where the document came from.
    - `sourceUrl` string, nullable: Page the asset or document was taken from.
    - `author` string, nullable: Who made the asset, where it is credited.
    - `license` string, nullable: Licence the asset is held under, where one is recorded.
    - `createdAt` string: When the record was first added, `YYYY-MM-DD HH:MM:SS` in UTC.

## 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)