Skip to content

Who am I — the signed-in user

GET
/v1/me
curl --request GET \
--url https://beta-api.plune.ai/v1/me \
--cookie plune_session=<plune_session>

The current session user (id, email, role, display name, language, theme). The dashboard reads it to show the account and, when you sign in, to open in the language and the theme you chose in another browser.

The signed-in user

Media type application/json
object
userId
required
string format: uuid
email
required
string format: email
name
required

The display name (B8-team T3) — what every screen shows where a row names this person, in place of the address. null until given on the Account page.

string
nullable <= 100 characters
locale
required

The language the person chose for the dashboard (#1016), kept with the account so another browser opens in it. null until they choose one: the browser’s own preference stands in, and nothing is written on its behalf.

string
nullable
Allowed values: en uk
theme
required

The theme the person chose for the dashboard (#1016), kept with the account like locale. null until they choose one.

string
nullable
Allowed values: dark light
emailJobEnds
required

«Also by email» (#1925): the end of a long operation the person started (an import, an export, an ingest, a sync) comes as a letter to the sign-in address too. The notification on the bell comes either way. false for every account until the person turns it on.

boolean
consent
required

When the person accepted the Terms of Service and the Privacy Policy on the first sign-in screen (#2490), and the version of each (the date the page was last updated). null until then.

object
at
required
string format: date-time
termsVersion
required
string
nullable
privacyVersion
required
string
nullable
consentRequired
required

true while consent is null or names a version older than the current one: the dashboard then shows the first sign-in screen in place of every page (#2490). No other route of the api refuses on it, so API tokens keep working.

boolean
tier

Free and Personal are an account’s, Team and Enterprise a company’s; Free may also be a company’s, as the row that cancels its Team.

string
Allowed values: free personal team enterprise
tierState

Worked out from the grants at the database’s clock, never stored. active: a paid grant covers now. grace: it ended or was cancelled less than 14 days ago, and the limits are still the tier’s. expired: the 14 days are over — Free. disabled: the operator switched it off — Free at once, and nothing is deleted for 14 days. No grant ever is plain Free, active.

string
Allowed values: active grace expired disabled
options

What a grant carries besides its tier. A free grant carries none.

object
saml
boolean
extra_storage_packs
integer
<= 1000
extra_full_months
integer
<= 120
seats

The seats a payment bought (#1055). Only a payment writes it; the owner’s grant cannot.

integer
>= 1
tierValidUntil

When the paid period ends (or ended, in grace); null without an end and on Free.

string format: date-time
nullable
tierGraceEndsAt

Until when nothing is deleted: the end of the 14 days in grace and disabled; null when active or expired.

string format: date-time
nullable
role
required

What this account is allowed to be, e.g. user or owner. Open-ended: new roles appear without a client release.

string
Example
{
"userId": "u-shop",
"email": "owner@example.com",
"role": "user",
"name": "Olena Kovalenko",
"locale": "uk",
"theme": "light",
"emailJobEnds": false,
"consent": {
"at": "2026-11-17T13:30:00.000Z",
"termsVersion": "2026-11-17",
"privacyVersion": "2026-11-17"
},
"consentRequired": false,
"tier": "personal",
"tierState": "active",
"options": {},
"tierValidUntil": "2027-10-15T09:00:00.000Z",
"tierGraceEndsAt": null
}

No / invalid session

Session valid but the user no longer exists

Media type application/json
object
error
required
string
Example generated
{
"error": "example"
}