This endpoint may be used to get information of users and modify them.
| Property | Type | Description |
|---|---|---|
| id | integer | The unique identifier of this user |
| displayName | string | The display name of this user |
| username | string | The username/"@-handle" of this user |
| avatarURL | string | The URL of this user's avatar |
| header | ?string | The URL of this user's header image |
| bio | ?string | The biography of this user |
| birthday | ?string | The birthday date of this user in the format "Y-m-d" |
| privacyLevel | string | The privacy level of this user, one of these values: PUBLIC / PRIVATE / CLOSED
|
| time | string | The timestamp of when this user was created |
| verified | boolean | Whether or not this user has a verified badge |
| suspended | boolean | Whether or not this user's account was suspended |
| totalPostCount | integer | The total amount of feed entries this user has created |
| followingCount | integer | The amount of users this user follows |
| followerCount | integer | The amount of users that follow this user |
| favoritesCount | integer | The amount of posts this user has favorited |
| followsYou | boolean | Whether or not this user follows the currently authenticated user, false if not authenticated |
| blocked | boolean | Whether or not the currently authenticated user has blocked this user, false if not authenticated |
| features | ?string[] | Additional features that were enabled for this user |
| identities | ?LinkedAccount[] | This user's linked identities |
| Property | Type | Description |
|---|---|---|
| id | integer | The unique identifier of this linked account |
| service | string | The service that this linked account is a part of, one of these values: DISCORD / TWITCH
/ TWITTER |
| linkedUserId | string | The id of this account in the third-party service's system |
| linkedUserName | string | The name of this account in the third-party service's system |
| linkedUserAvatar | ?string | The URL of this account's profile image |
| time | string | The timestamp of when this account was created |
| lastUpdate | string | The timestamp of when this account was last updated |
Gets a User object by their username.
| Property | Type | Description |
|---|---|---|
| user | string | The username of the user to be found (case-insensitive) |
Returns a single User object.