Workspace: GET /v1/me
The key and the one workspace it unlocks: name, type, platform, currency, tax rate, modules, write access and trial state.
Workspace
The key and its workspace
GET
/v1/me
any key
Works with any valid key. Use it to confirm a key, discover its scopes, and read the workspace's currency and tax rate before formatting money.
Example
curl https://api.pricemaster.ai/v1/me -H "Authorization: Bearer $PRICEMASTER_KEY"{
"currency": "GBP",
"tax_rate": "20.00",
"key": {
"id": 12,
"name": "ERP nightly sync",
"prefix": "pmk_live_a1b2c3d4",
"scopes": [
{
"scope": "workspace:read",
"description": "Read the workspace: name, type, currency, tax rate, modules, trial state and the key's own details (/v1/me)."
},
{
"scope": "products:read",
"description": "Read your products: SKU, title, identifiers, cost, prices, stock, tags and market position."
}
]
},
"workspace": {
"id": 22,
"name": "Trade Counter Direct",
"type": "retail",
"platform": "shopify",
"country": "GB",
"currency": "GBP",
"tax_rate": "20.00",
"modules": {
"sales": true,
"pim": false,
"public_api": true
},
"writes_enabled": false,
"trial": null
}
}
workspace.type is retail or brand. modules lists every per-workspace feature flag; endpoints that depend on a module answer 403 module_not_enabled when it is off. trial is present for workspaces on a managed free trial, with the day count and the manual pushes remaining today.
Something out of date or unclear?
Tell us →