---
title: "List the shops this key may act for"
method: GET
path: "/v1/vendor/shops"
tags: ["Seller"]
---

# List the shops this key may act for

`GET /v1/vendor/shops`

## Request

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

An integration is handed a key, not a shop id. This is where it learns them. An account may run more than one shop and name the same key on each; when it has, every other vendor call needs `?vendor=` to say which, and this endpoint is how a script finds the id rather than having it read out of the website. A shop that is not `approved` accepts writes but shows nothing publicly.

**An empty array means the key is not named by any shop yet**, not that anything is wrong with it. Holding an Enterprise plan is what buys access to this API; a shop naming the key in Profile > Seller is what gives it a shop to act for, and the two are deliberately separate (there is no scope on an API key). Call this first: every other vendor route refuses a key no shop names, because each of them needs a shop to act on.

**Requires Enterprise tier or higher.**

## Response `200`

List the shops this key may act for

- 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 shop. This is the value to send as `?vendor=`.
    - `name` string: Display name, as the maker writes it.
    - `website` string, nullable: Official website, where one is known.
    - `currency` string, nullable: ISO 4217 code the price is in, e.g. `AUD`. Prices are integer minor units; format with `Intl.NumberFormat` at render rather than dividing first.
    - `approved` boolean: Whether staff have approved the shop. An unapproved shop accepts writes but shows nothing publicly.

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