The account behind the credential that asked. Everything `User` carries, plus the two properties a public profile withholds. A separate schema rather than `User` with optional fields, so a public profile cannot carry an email address at all. A client routing on `object` gets `me` here and `user` there, so an absent email is never ambiguous between "not served" and "not set". The account's own edges are not properties of it. Which teams it is on, what it subscribes to, what it saved and what it liked are four collections of their own: `GET /memberships`, `GET /subscriptions`, `GET /saved-articles` and `GET /liked-articles`. Not carried: theme and contrast, notification preferences, push subscriptions and read state.
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://artifacts.apis.io/usecommune/json-schema/usecommune-me-schema.json",
"title": "Me",
"description": "The account behind the credential that asked.\n\nEverything `User` carries, plus the two properties a public profile\nwithholds. A separate schema rather than `User` with optional fields, so\na public profile cannot carry an email address at all. A client routing\non `object` gets `me` here and `user` there, so an absent email is never\nambiguous between \"not served\" and \"not set\".\n\nThe account's own edges are not properties of it. Which teams it is on,\nwhat it subscribes to, what it saved and what it liked are four\ncollections of their own: `GET /memberships`, `GET /subscriptions`,\n`GET /saved-articles` and `GET /liked-articles`.\n\nNot carried: theme and contrast, notification preferences, push\nsubscriptions and read state.\n",
"x-generated": "2026-11-10",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/usecommune-users-api-openapi.yml#/components/schemas/Me",
"type": "object",
"additionalProperties": false,
"required": [
"object",
"id"
],
"properties": {
"object": {
"type": "string",
"const": "me",
"description": "Always `me`."
},
"id": {
"type": "string",
"description": "Stable identifier. The same value `User.id` carries, so a client\ncan match itself against an author or a message it has already\nread.\n"
},
"username": {
"type": [
"string",
"null"
],
"description": "The unique handle the public profile resolves on at\n`/@{username}`. Null for an account that has not finished signing\nup.\n"
},
"display_name": {
"type": [
"string",
"null"
],
"description": "The name shown next to their messages and bylines. Null when it was\nnever set; a blank name is reported as null rather than as an empty\nstring.\n"
},
"avatar": {
"type": [
"string",
"null"
],
"format": "uri",
"description": "Profile picture. Commune falls back to a generated avatar when the\nperson never set one, so this is rarely null in practice.\n"
},
"email": {
"type": [
"string",
"null"
],
"format": "email",
"description": "The address Commune sends this account's own mail to. Only ever\nthis account's own, and never returned for anybody else.\n"
},
"email_verified": {
"type": "boolean",
"description": "Whether the address above has been confirmed.\n"
},
"created_at": {
"type": [
"string",
"null"
],
"format": "date-time",
"description": "When the account was created."
}
}
}
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.