Reference

Account

The key itself: which store it belongs to, what it may do, and when it expires. GET /v2/whoami is the cheapest way to prove a key works.

GETWhich store and key this is/whoami

Which store and key this is

GETapi.stockroom.app/v2/whoami

Scope: read · every key has it

The first call an integration makes, and the cheapest "is my key alive" probe.

Responses

200

The store and the key.

Whoami

400 401 402 403 404 422 429

The refusals every route shares: unauthorized, feature_not_enabled, insufficient_scope, not_found, bad_request, validation_failed, invalid_transition, rate_limited. Each is an Error.

Request

curl "https://api.stockroom.app/v2/whoami" \
  -H "Authorization: Bearer $STOCKROOM_KEY"

Response 200

{
  "shop": {
    "id": 12,
    "domain": "example.myshopify.com",
    "name": "Example Store",
    "currency": "USD",
    "timezone": "America/Chicago"
  },
  "key": {
    "id": 4,
    "name": "ERP key",
    "prefix": "srk2_ab12cd34",
    "scopes": [
      "read",
      "write:purchase_orders"
    ],
    "expires_at": null
  },
  "api_version": "2"
}