---
title: "Get a shared collection"
method: GET
path: "/v1/collections/{shareId}"
tags: ["Collections"]
---

# Get a shared collection

`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

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.

## Path parameters

- `shareId` string, required

## Response `200`

Get a shared collection

- object
  - `success` boolean, required: Always true on a successful response. Every error carries `false` and an `error` object instead.
  - `data` object, required: The response payload.
    - `id` string: Internal id of the collection. Not a credential; the share id is.
    - `name` string: Display name, as the maker writes it.
    - `description` string, nullable: Prose summary of the record, where one has been written.
    - `shareId` string: The 10-character public share id, echoing the path parameter.
    - `itemCount` integer: How many firearms the collection holds.
    - `createdAt` string: When the record was first added, `YYYY-MM-DD HH:MM:SS` in UTC.
    - `items` FirearmListItem[]: The rows this response carries.
      - `id` string: URL-safe slug identifying the firearm, e.g. `glock-g17-gen5`. Stable: it is what a mirror keys on.
      - `name` string: Display name, as the maker writes it.
      - `manufacturerId` string: Slug of the manufacturer that makes it. Resolve against `/v1/manufacturers/{id}`.
      - `categoryId` string: Slug of the category it belongs to. Resolve against `/v1/categories`.
      - `yearIntroduced` integer, nullable: Year it entered production or service. Null where the date is disputed or unknown.
      - `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.
      - `countryOfOrigin` string, nullable: ISO 3166-1 alpha-2 code of where it was designed, e.g. `AT`.
      - `actionType` string, nullable: How the action cycles: `short_recoil`, `gas_operated`, `blowback`, `bolt_action` and so on. An open vocabulary: the values in use are published on the schema as `x-gunspec-vocabulary`, and `GET /v1/firearms/action-types` is the live list.
      - `weightEmptyG` number, nullable: Unloaded weight in grams, without magazine.
      - `barrelLengthMm` number, nullable: Barrel length in millimetres, measured from the breech face.
      - `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.
      - `createdAt` string: When the record was first added, `YYYY-MM-DD HH:MM:SS` in UTC.
      - `svgLineArtUrl` string, nullable: Line-art silhouette, or null where none has been drawn.
      - `model3dUrl` string, nullable: GLB model, or null where none is on file.
      - `favoriteCount` integer: How many accounts have favorited this record.
      - `updatedAt` string: When a field we serve last changed. Maintained by the database rather than by whatever wrote the row, so it moves for a corrected specification and does not move for a re-run of the importer.
      - `version` string, nullable: Opaque fingerprint of this record. It changes when and only when a field we serve changes, so a client holding the same value already has the record and need not fetch it. Equality is the only supported operation: do not parse it, and do not assume how it is computed. Null means the record has not been written since versioning began, not that it is unchanged.

## Other responses

- `400`: Validation error
- `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)