Users

Retrieve the authenticated account

The account this credential belongs to: the public profile GET /users/{user} returns, plus the email address and verification state that profile withholds.

Any credential this API accepts can call it, an API key included, and no permission is required. GET /memberships, GET /subscriptions, GET /saved-articles and GET /liked-articles are different and do need account: read.

get/me

Request

  • Base URL: https://api.usecommune.com
  • URL: https://api.usecommune.com/me
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://usecommune.com/api/oauth/authorize, token URL https://usecommune.com/api/oauth/token)

Query parameters

fieldsstring

Comma-separated allow-list of top level properties to return on each object, so a client can trim a response it does not need in full. id and object are always returned. An unknown property name answers 400. Properties omitted by an operation, such as content on any article list, cannot be brought back with fields.

Response

The authenticated account.

object'me' required

Always me.

idstring required

Stable identifier. The same value User.id carries, so a client can match itself against an author or a message it has already read.

usernamestring nullable

The unique handle the public profile resolves on at /@{username}. Null for an account that has not finished signing up.

display_namestring nullable

The name shown next to their messages and bylines. Null when it was never set; a blank name is reported as null rather than as an empty string.

avatarstring uri nullable

Profile picture. Commune falls back to a generated avatar when the person never set one, so this is rarely null in practice.

emailstring email nullable

The address Commune sends this account's own mail to. Only ever this account's own, and never returned for anybody else.

email_verifiedboolean

Whether the address above has been confirmed.

created_atstring date-time nullable

When the account was created.

Changes

No recorded changes to this operation across all 1 revision of this API.