Users

Retrieve a user

Read one public profile by id or by username. This is the whole public shape of a person in Commune.

get/users/{user}

Request

  • Base URL: https://api.usecommune.com
  • URL: https://api.usecommune.com/users/{user}
  • 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 user.

object'user' required

Always user.

idstring required

Stable identifier.

usernamestring nullable

The unique handle the 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.

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.

Changes

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