/
FO
forem
Search skmtc…
⌘K
Docs
Sign in
Docs
History
Schema
Generate
Filter operations
agent_sessions
5
analytics
8
articles
14
badge_achievements
4
badges
5
billboards
6
comments
3
concepts
11
events
5
feedback_messages
1
followed_tags
1
followers
1
follows
1
health_checks
3
images
2
instance
1
openapi
1
organizations
8
pages
6
podcast_episodes
1
profile images
1
reactions
2
readinglist
1
recommended_articles_lists
4
request_redirects
5
segments
7
subforems
1
surveys
7
tags
6
trends
3
users
27
put
/api/users/{id}/suspend
Suspend a User
put
/api/users/{id}/limited
Add limited role for a User
delete
/api/users/{id}/limited
Remove limited for a User
put
/api/users/{id}/spam
Add spam role for a User
delete
/api/users/{id}/spam
Remove spam role from a User
put
/api/users/{id}/trusted
Add trusted role for a User
delete
/api/users/{id}/trusted
Remove trusted role from a User
put
/api/users/{id}/base_subscriber
Add base_subscriber role for a User
delete
/api/users/{id}/base_subscriber
Remove base_subscriber role from a User
get
/api/users/me
The authenticated user
get
/api/users/{id}
A User
get
/api/users/search
Search for users
put
/api/users/{id}/unpublish
Unpublish a User's Articles and Comments
get
/api/admin/users
List all users (Admin)
post
/api/admin/users
Invite a User
get
/api/admin/users/{id}
Get user detail (Admin)
patch
/api/admin/users/{id}
Update user profile (Admin)
put
/api/admin/users/{id}/email
Update user email (Admin)
put
/api/admin/users/{id}/status
Update user moderation status (Admin)
put
/api/admin/users/{id}/notification_settings
Update user notification settings (Admin)
post
/api/admin/users/{id}/merge
Merge user into another (Admin)
get
/api/admin/users/{user_id}/notes
List notes for a user (Admin)
post
/api/admin/users/{user_id}/notes
Add a note to a user (Admin)
get
/api/admin/users/{user_id}/identities
List identities for a user (Admin)
post
/api/admin/users/{user_id}/identities
Link an identity to a user (Admin)
delete
/api/admin/users/{user_id}/identities/{id}
Unlink an identity from a user (Admin)
post
/api/admin/users/identities/bulk
Bulk link identities (Admin)
videos
1
users
Copy
Copy Markdown
Copy Markdown
Copying…
Copied
Copy failed
Changes to Add a note to a user (Admin)
post
/api/admin/users/{user_id}/notes
Jul 13, 2026
v1
7db6ba099285
Revision changes
info
endpoint added
Jan 10, 2023
v1
754f8b25f815
Revision changes
breaking
api path removed without deprecation