REST API endpoints for Users
Get a user
Section titled “Get a user”/users/{userId} Authentication may enable this endpoint return more information.
Authenticated user can retrieve private information when the target user is the current authenticated user and has user:read scope.
userId string Required The id or username of the user to retrieve.
Can be also @me for the current authenticated user.
This API endpoint returns standard API response format. The following fields are fields of the data object. Learn more
id string Required The unique identifier of the user.
name string Required The display name of the user.
username string Required The username of the user.
created_at string Required ISO 8601 timestamp of when the user was created.
role string Required The role of the user. Can be user, moderator or admin.
avatar_url string The URL of the user avatar.
bio string The short bio of the user.
auth_id string The auth provider identifier of the user. Only available if requesting your own account.
Modify a user
Section titled “Modify a user”/users/{userId} Can only update the current authenticated user.
Authentication is required.
Access token must have user:update scope.
userId string Required The id or username of the user to retrieve.
Can be also @me for the current authenticated user.
Only the provided fields will be updated. To remove an optional field, set it to null.
name string The display name of the user.
Regex: /^[p{L}p{N} _-]+$/u
bio string The short bio of the user.
This API endpoint returns standard API response format. The following fields are fields of the data object. Learn more
id string Required The unique identifier of the user.
name string Required The display name of the user.
username string Required The username of the user.
created_at string Required ISO 8601 timestamp of when the user was created.
role string Required The role of the user. Can be user, moderator or admin.
avatar_url string The URL of the user avatar.
bio string The short bio of the user.
auth_id string The auth provider identifier of the user. Only available if requesting your own account.