Skip to content

Who am I, and what can this key do

GET
/me

Shop, plan, entitlements, location counts — and the CALLING KEY'S OWN scopes and location restriction. An integrator's first call, and the fastest way to resolve a 403.

Authorizations

ApiKeyBearer

A shop-scoped API key created in the dashboard and shown exactly once. An MCP tmk_ key presented here returns a 401 that names the mistake.

Type
HTTP (bearer)

Responses

Who am I, and what can this key do

application/json
JSON
{
  
"shop": {
  
  
"id": "shp_docsfixture0001",
  
  
"api_addon": true,
  
  
"included_locations": 0,
  
  
"billable_locations": 3,
  
  
"max_locations": null,
  
  
"max_cards": null
  
},
  
"entitlements": {
  
  
"api_access": true,
  
  
"webhooks_advanced": true,
  
  
"mcp_access": true,
  
  
"source": {
  
  
  
"api_access": "addon"
  
  
},
  
  
"grant_expires_at": null
  
},
  
"api_key": {
  
  
"id": "ak_docsfixture0001",
  
  
"scopes": [
  
  
  
"cards:write"
  
  
],
  
  
"location_ids": [
  
  
  
"loc_docsfixture0001"
  
  
]
  
}
}

Samples

Powered by VitePress OpenAPI

Requires the Business API add-on.