Collections

Get a shared collection

Returns a user collection that has been shared publicly, together with the firearms in it. The 10-character share id is the only credential; unshared collections are not reachable here.

No API key required.

get/v1/collections/{shareId}

Request

  • Base URL: https://api.gunspec.io
  • URL: https://api.gunspec.io/v1/collections/{shareId}
  • Auth: one of:
    • none
    • API key in header X-API-Key
    • HTTP bearer

Path parameters

shareIdstring required

10-character public share id

Response

Get a shared collection

successboolean required

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

Example response

{
  "success": true,
  "data": {
    "id": "col_01H8",
    "name": "Service pistols",
    "description": "Standard-issue sidearms",
    "shareId": "a1b2c3d4e5",
    "itemCount": 12,
    "createdAt": "2026-01-15T12:00:00.000Z",
    "items": [
      {
        "id": "glock-g17-gen5",
        "name": "Glock 17 Gen5",
        "manufacturerId": "glock",
        "categoryId": "pistol",
        "yearIntroduced": 2017,
        "countryOfOrigin": "AT",
        "actionType": "short_recoil",
        "weightEmptyG": 625,
        "barrelLengthMm": 114,
        "images": [
          {
            "id": 2572,
            "url": "https://api.gunspec.io/v1/firearms/ak-47/images/2572",
            "alt": "AK-47 right profile",
            "width": 1536,
            "height": 1024
          }
        ],
        "createdAt": "2026-09-06 23:55:07",
        "svgLineArtUrl": "https://api.gunspec.io/v1/firearms/glock-g17-gen5/media/silhouette",
        "updatedAt": "2026-09-10 06:42:19",
        "version": "a3f1c2d4e5b6a7c8d9e0f1a2b3c4d5e6f7a8b9c0d1e2f3a4b5c6d7e8f9a0b1c2"
      }
    ]
  }
}

Changes

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