Account

List your favorites

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.

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

Query parameters

pageinteger

Page number

per_pageinteger

Items per page (max 100). Preferred over limit.

limitinteger

Legacy alias for per_page. per_page wins if both are sent.

Response

List your favorites

successboolean required

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

Example response

{
  "success": true,
  "data": [
    {
      "id": "glock-g17-gen5",
      "firearm_id": "glock-g17-gen5",
      "favorited_at": "2026-05-01 09:14:03",
      "name": "Glock 17 Gen5",
      "manufacturer_id": "glock",
      "manufacturer_name": "Glock Ges.m.b.H.",
      "category_id": "pistol",
      "category_name": "Pistol",
      "year_introduced": 2017,
      "action_type": "short_recoil",
      "country_of_origin": "AT",
      "weight_empty_g": 625,
      "barrel_length_mm": 114,
      "favorite_count": 12,
      "images": [
        {
          "id": 2572,
          "url": "https://api.gunspec.io/v1/firearms/ak-47/images/2572",
          "alt": "AK-47 right profile",
          "width": 1536,
          "height": 1024
        }
      ]
    }
  ],
  "pagination": {
    "page": 1,
    "per_page": 20,
    "limit": 20,
    "total": 42,
    "totalPages": 3
  }
}

Changes

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