Me

GET /v1/me tells you which key you're using and what it can do. It needs no permission, so it's the right first call when you set up an integration, and a cheap health check.

curl https://app.ironregister.com/api/v1/me -H "Authorization: Bearer $KEY"

{
  "status": "ok",
  "data": {
    "object": "api_key",
    "id": 12,
    "name": "Flxpoint",
    "key": "ir_live_4Tq9…Xa2P",
    "environment": "live",
    "scopes": { "products": "write", "inventory": "write", "customers": "read", "customer_dob": "none", "orders": "write", "returns": "read", "purchase_orders": "read", "gift_certificates": "none", "coupons": "none", "locations": "read", "range": "none" },
    "location_ids": null,
    "expires_at": null,
    "shop": { "id": 117, "name": "Demo Armory", "slug": "demo-armory", "plan": "enterprise" },
    "rate_limit": { "per_minute": 600, "per_day": null },
    "api_version": "2026-09-24",
    "addons": ["range"],
    "catalog": { "resources": [ "…" ], "events": [ "…" ], "presets": { "…": "…" } }
  }
}

Field	Meaning
environment	live or sandbox
scopes	The key's permission grid (see Permissions)
location_ids	The location ids the key is limited to, or null for every location
rate_limit	The shop's allowance; per_day: null means no daily cap
addons	Add-ons the shop has, e.g. range
catalog	Every resource and webhook event, with whether each is available to this shop