---
title: "Get a platform"
method: GET
path: "/v1/platforms/{id}"
tags: ["Compatibility"]
---

# Get a platform

`GET /v1/platforms/{id}`

## Request

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

A platform with its default interfaces and its member firearms.

**Requires Studio tier or higher.**

## Path parameters

- `id` string, required

## Headers

- `If-None-Match` string

## Response `200`

Get a platform

- 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: Slug of the platform.
    - `name` string: Display name, as the maker writes it.
    - `description` string, nullable: Prose summary of the record, where one has been written.
    - `interfaces` object[]: The mount interfaces resolved for this firearm, own rows first, then inherited.
      - `position` string: Where on the firearm the interface sits: `muzzle`, `rear`, `top`, `bottom`.
      - `standardId` string: Id of the interface standard, kind-prefixed, e.g. `thread:1/2x28`. Ids are never renamed; new spellings become aliases.
      - `name` string: Display name, as the maker writes it.
      - `kind` string: What the asset is: `silhouette`, `render`, `photo`, `schematic`, `model`. `/v1/firearms/{id}/media/{selector}` addresses an asset by this.
      - `confidence` number: How well evidenced this row is, 0 to 1. **A minimum, not an average**: an inferred row caps every fit computed through it, and `min_confidence` on the endpoint hides rows below a threshold.
      - `notes` string, nullable: Free-text notes that do not belong in a specific field.
    - `members` object[]: The firearms belonging to this platform, which inherit its default interfaces.
      - `id` string: Slug of the firearm.
      - `name` string: Display name, as the maker writes it.

## Other responses

- `304`: Your copy is current. No body is sent, and this response does not count toward the daily request allowance.
- `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)