---
title: "List your favorites"
method: GET
path: "/v1/me/favorites"
tags: ["Account"]
---

# List your favorites

`GET /v1/me/favorites`

## Request

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

Returns the firearms the calling account has favorited, newest first.

Requires an API key belonging to a user account. Acts on the calling account's own data.

## Query parameters

- `page` integer
- `per_page` integer
- `limit` integer

## Response `200`

List your favorites

- object
  - `success` boolean, required: Always true on a successful response. Every error carries `false` and an `error` object instead.
  - `data` FavoriteFirearm[], required: One page of results. Use `pagination` to walk the rest.
    - `id` string, required: URL-safe slug identifying the firearm. The same value as `firearm_id`.
    - `firearm_id` string, required: Slug of the firearm, under the favorites table's own column name. The same value as `id`.
    - `favorited_at` string, required: When this account favorited it, as the database stamps it (`YYYY-MM-DD HH:MM:SS`, UTC). The list is ordered by this, newest first.
    - `name` string, required: Display name, as the maker writes it.
    - `manufacturer_id` string, nullable: Slug of the manufacturer. `manufacturerId` on the camelCase endpoints.
    - `manufacturer_name` string, nullable: Display name of the manufacturer, joined in so a card renders without a second call.
    - `category_id` string, nullable: Slug of the category. `categoryId` on the camelCase endpoints.
    - `category_name` string, nullable: Display name of the category.
    - `status` 'in_production' | 'discontinued' | 'out_of_production' | 'in_service' | 'limited_production' | 'prototype': Production status of a firearm. Closed: these are every value the catalog holds.
    - `year_introduced` integer, nullable: Year the model was introduced.
    - `action_type` string, nullable: Operating action as stored, underscored, e.g. `short_recoil`, `bolt_action`, `gas_operated`. The full vocabulary is `/v1/firearms/action-types`; a hyphenated value matches nothing.
    - `country_of_origin` string, nullable: ISO 3166-1 alpha-2 code of the country of origin.
    - `weight_empty_g` number, nullable: Unloaded weight in grams, one of the two figures a catalogue card draws beside the year. Null where the record has none.
    - `barrel_length_mm` number, nullable: Barrel length in millimetres, the other of the two figures a card draws. Null where the record has none.
    - `svg_line_art_url` string, nullable: Line-art silhouette, or null where none has been drawn.
    - `model_3d_url` string, nullable: GLB model, or null where none is on file.
    - `favorite_count` integer: How many accounts have favorited this record.
    - `images` InlineMediaItem[]: Every image this firearm has, silhouette first. Empty when none are on file.
      - `id` integer, required: Autoincrementing image id.
      - `url` string, required: Absolute, directly fetchable URL.
      - `kind` 'silhouette' | 'render' | 'photo' | 'schematic' | 'model', required: What kind of asset a media row is.
      - `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.
  - `pagination` Pagination: Page-size is reported under both `per_page` (matching the request parameter) and `limit` (retained for existing integrations). They always carry the same value. `total` and `totalPages` are omitted for Explorer and anonymous callers.
    - `page` integer, required: The page this response is, 1-based.
    - `per_page` integer, required: Page size. Same value as `limit`.
    - `limit` integer, required: Page size. Alias of `per_page`.
    - `total` integer: Total records matching the query across every page.
    - `totalPages` integer: How many pages the result set spans at the current `per_page`.

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