Reference
Method: GET Path: /public/v1/me Auth: Bearer marketplace token (any active install, any scopes) Tenant guard: not applicable Required scope: none
Request
curl -s -H "Authorization: Bearer $HB_TOKEN" \
https://api.hellobooks.com/public/v1/me | jqResponse
{
"install_id": "65f0a1b2c3d4e5f6a7b8c9d0",
"client_id": "cli_abc123",
"app_slug": "your-app-slug",
"org_ref_id": "65a0...",
"entity_ref_id": "66b1...",
"scopes": ["invoices:read", "bills:read"]
}| Field | Type | Notes |
|---|---|---|
install_id | string | Mongo ObjectId of your AppInstall row. Stable across token rotations. |
client_id | string | Your marketplace app's client identifier. |
app_slug | string | The slug you registered for your app. |
org_ref_id | string | The org this install is scoped to. Use as :orgId in tenant URLs. |
entity_ref_id | string | The entity this install is scoped to. Use as :entityId in tenant URLs. |
scopes | string[] | Scopes the user granted at install time. |
Recommended usage
Call /me once after every successful install and store the result against your local install record. Don't call it on every request — it's not free, and the values don't change between installs.
Re-call it if you add scopes (the user must re-authorize, which mints a new install context).