User APIs
Last updated
Was this helpful?
Last updated
Was this helpful?
This api is used for fetching the user details based on user slug from nodebb.
/user/{userslug}
{"websiteLink":"websiteLink","_header":{},"reputation":5,"blocksCount":true,"posts":[{"upvotes":5,"pid":6,"timestampISO":"timestampISO","downvotes":9,"tid":7,"content":"content","uid":1,"deleted":true,"isMainPost":true,"topic":{"uid":8,"deleted":3,"postcount":6,"titleRaw":"titleRaw","mainPid":1,"title":"title","teaserPid":{},"tid":9,"slug":"slug","cid":6},"votes":9,"category":{"parentCid":6,"bgColor":"bgColor","color":"color","backgroundImage":{},"name":"name","icon":"icon","slug":"slug","cid":2,"imageClass":"imageClass"},"user":{"uid":6,"icon:bgColor":"icon:bgColor","icon:text":"icon:text","userslug":"userslug","picture":{},"username":"username","status":"status"},"timestamp":4},{"upvotes":5,"pid":6,"timestampISO":"timestampISO","downvotes":9,"tid":7,"content":"content","uid":1,"deleted":true,"isMainPost":true,"topic":{"uid":8,"deleted":3,"postcount":6,"titleRaw":"titleRaw","mainPid":1,"title":"title","teaserPid":{},"tid":9,"slug":"slug","cid":6},"votes":9,"category":{"parentCid":6,"bgColor":"bgColor","color":"color","backgroundImage":{},"name":"name","icon":"icon","slug":"slug","cid":2,"imageClass":"imageClass"},"user":{"uid":6,"icon:bgColor":"icon:bgColor","icon:text":"icon:text","userslug":"userslug","picture":{},"username":"username","status":"status"},"timestamp":4}],"sso":[{},{}],"icon:text":"icon:text","isGlobalModerator":true,"joindate":0,"profile_links":[{},{}],"reputation:disabled":true,"banned_until_readable":"banned_until_readable","allowCoverPicture":true,"isAdmin":true,"moderationNote":"moderationNote","ips":{},"latestPosts":[null,null],"aboutme":"aboutme","email:confirmed":true,"isTargetAdmin":true,"isAdminOrGlobalModerator":true,"emailClass":"emailClass","loggedIn":true,"downvote:disabled":true,"topiccount":2,"relative_path":"relative_path","isSelf":true,"breadcrumbs":[{},{}],"status":"status","birthday":"birthday","template":{},"showHidden":true,"yourid":1,"lastposttime":7,"isModerator":true,"signature":"signature","icon:bgColor":true,"canEdit":true,"flags":"flags","groupTitle":"groupTitle","isBlocked":true,"bestPosts":[null,null],"title":"title","widgets":{},"followingCount":2,"lastonlineISO":"lastonlineISO","email:disableEdit":true,"uid":"uid","groupTitleArray":["groupTitleArray","groupTitleArray"],"canChangePassword":true,"profileviews":1,"bodyClass":"bodyClass","cover:url":"cover:url","selectedGroup":[{},{}],"banned":true,"banned_until":4,"userslug":"userslug","followerCount":3,"email":"email","website":"website","isFollowing":true,"uploadedpicture":"uploadedpicture","canBan":true,"lastonline":6,"disableSignatures":true,"banned:expire":9,"groups":[{},{}],"username:disableEdit":true,"joindateISO":"joindateISO","url":"url","isSelfOrAdminOrGlobalModerator":true,"websiteName":"websiteName","hasPrivateChat":1,"isAdminOrGlobalModeratorOrModerator":true,"cover:position":"cover:position","postcount":5,"location":"location","fullname":"fullname","aboutmeParsed":"aboutmeParsed","age":7,"theirid":1,"username":"username"}
This api is used for fetching the user details based on nodebb uid.
/user/uid/{uid}
This api is used for fetching the user upvote details from nodebb.
/user/{userslug}/upvoted
{"websiteLink":"websiteLink","_header":{},"reputation":5,"blocksCount":true,"posts":[{"upvotes":5,"pid":6,"timestampISO":"timestampISO","downvotes":9,"tid":7,"content":"content","uid":1,"deleted":true,"isMainPost":true,"topic":{"uid":8,"deleted":3,"postcount":6,"titleRaw":"titleRaw","mainPid":1,"title":"title","teaserPid":{},"tid":9,"slug":"slug","cid":6},"votes":9,"category":{"parentCid":6,"bgColor":"bgColor","color":"color","backgroundImage":{},"name":"name","icon":"icon","slug":"slug","cid":2,"imageClass":"imageClass"},"user":{"uid":6,"icon:bgColor":"icon:bgColor","icon:text":"icon:text","userslug":"userslug","picture":{},"username":"username","status":"status"},"timestamp":4},{"upvotes":5,"pid":6,"timestampISO":"timestampISO","downvotes":9,"tid":7,"content":"content","uid":1,"deleted":true,"isMainPost":true,"topic":{"uid":8,"deleted":3,"postcount":6,"titleRaw":"titleRaw","mainPid":1,"title":"title","teaserPid":{},"tid":9,"slug":"slug","cid":6},"votes":9,"category":{"parentCid":6,"bgColor":"bgColor","color":"color","backgroundImage":{},"name":"name","icon":"icon","slug":"slug","cid":2,"imageClass":"imageClass"},"user":{"uid":6,"icon:bgColor":"icon:bgColor","icon:text":"icon:text","userslug":"userslug","picture":{},"username":"username","status":"status"},"timestamp":4}],"sso":[{},{}],"icon:text":"icon:text","isGlobalModerator":true,"joindate":0,"profile_links":[{},{}],"reputation:disabled":true,"banned_until_readable":"banned_until_readable","allowCoverPicture":true,"isAdmin":true,"moderationNote":"moderationNote","ips":{},"latestPosts":[null,null],"aboutme":"aboutme","email:confirmed":true,"isTargetAdmin":true,"isAdminOrGlobalModerator":true,"emailClass":"emailClass","loggedIn":true,"downvote:disabled":true,"topiccount":2,"relative_path":"relative_path","isSelf":true,"breadcrumbs":[{},{}],"status":"status","birthday":"birthday","template":{},"showHidden":true,"yourid":1,"lastposttime":7,"isModerator":true,"signature":"signature","icon:bgColor":true,"canEdit":true,"flags":"flags","groupTitle":"groupTitle","isBlocked":true,"bestPosts":[null,null],"title":"title","widgets":{},"followingCount":2,"lastonlineISO":"lastonlineISO","email:disableEdit":true,"uid":"uid","groupTitleArray":["groupTitleArray","groupTitleArray"],"canChangePassword":true,"profileviews":1,"bodyClass":"bodyClass","cover:url":"cover:url","selectedGroup":[{},{}],"banned":true,"banned_until":4,"userslug":"userslug","followerCount":3,"email":"email","website":"website","isFollowing":true,"uploadedpicture":"uploadedpicture","canBan":true,"lastonline":6,"disableSignatures":true,"banned:expire":9,"groups":[{},{}],"username:disableEdit":true,"joindateISO":"joindateISO","url":"url","isSelfOrAdminOrGlobalModerator":true,"websiteName":"websiteName","hasPrivateChat":1,"isAdminOrGlobalModeratorOrModerator":true,"cover:position":"cover:position","postcount":5,"location":"location","fullname":"fullname","aboutmeParsed":"aboutmeParsed","age":7,"theirid":1,"username":"username"}
This api is used for fetching the user down vote details from nodebb.
/user/{userslug}/downvoted
{"websiteLink":"websiteLink","_header":{},"reputation":5,"blocksCount":true,"posts":[{"upvotes":5,"pid":6,"timestampISO":"timestampISO","downvotes":9,"tid":7,"content":"content","uid":1,"deleted":true,"isMainPost":true,"topic":{"uid":8,"deleted":3,"postcount":6,"titleRaw":"titleRaw","mainPid":1,"title":"title","teaserPid":{},"tid":9,"slug":"slug","cid":6},"votes":9,"category":{"parentCid":6,"bgColor":"bgColor","color":"color","backgroundImage":{},"name":"name","icon":"icon","slug":"slug","cid":2,"imageClass":"imageClass"},"user":{"uid":6,"icon:bgColor":"icon:bgColor","icon:text":"icon:text","userslug":"userslug","picture":{},"username":"username","status":"status"},"timestamp":4},{"upvotes":5,"pid":6,"timestampISO":"timestampISO","downvotes":9,"tid":7,"content":"content","uid":1,"deleted":true,"isMainPost":true,"topic":{"uid":8,"deleted":3,"postcount":6,"titleRaw":"titleRaw","mainPid":1,"title":"title","teaserPid":{},"tid":9,"slug":"slug","cid":6},"votes":9,"category":{"parentCid":6,"bgColor":"bgColor","color":"color","backgroundImage":{},"name":"name","icon":"icon","slug":"slug","cid":2,"imageClass":"imageClass"},"user":{"uid":6,"icon:bgColor":"icon:bgColor","icon:text":"icon:text","userslug":"userslug","picture":{},"username":"username","status":"status"},"timestamp":4}],"sso":[{},{}],"icon:text":"icon:text","isGlobalModerator":true,"joindate":0,"profile_links":[{},{}],"reputation:disabled":true,"banned_until_readable":"banned_until_readable","allowCoverPicture":true,"isAdmin":true,"moderationNote":"moderationNote","ips":{},"latestPosts":[null,null],"aboutme":"aboutme","email:confirmed":true,"isTargetAdmin":true,"isAdminOrGlobalModerator":true,"emailClass":"emailClass","loggedIn":true,"downvote:disabled":true,"topiccount":2,"relative_path":"relative_path","isSelf":true,"breadcrumbs":[{},{}],"status":"status","birthday":"birthday","template":{},"showHidden":true,"yourid":1,"lastposttime":7,"isModerator":true,"signature":"signature","icon:bgColor":true,"canEdit":true,"flags":"flags","groupTitle":"groupTitle","isBlocked":true,"bestPosts":[null,null],"title":"title","widgets":{},"followingCount":2,"lastonlineISO":"lastonlineISO","email:disableEdit":true,"uid":"uid","groupTitleArray":["groupTitleArray","groupTitleArray"],"canChangePassword":true,"profileviews":1,"bodyClass":"bodyClass","cover:url":"cover:url","selectedGroup":[{},{}],"banned":true,"banned_until":4,"userslug":"userslug","followerCount":3,"email":"email","website":"website","isFollowing":true,"uploadedpicture":"uploadedpicture","canBan":true,"lastonline":6,"disableSignatures":true,"banned:expire":9,"groups":[{},{}],"username:disableEdit":true,"joindateISO":"joindateISO","url":"url","isSelfOrAdminOrGlobalModerator":true,"websiteName":"websiteName","hasPrivateChat":1,"isAdminOrGlobalModeratorOrModerator":true,"cover:position":"cover:position","postcount":5,"location":"location","fullname":"fullname","aboutmeParsed":"aboutmeParsed","age":7,"theirid":1,"username":"username"}
This api is used for fetching the user bookmark post details from nodebb.
/user/{userslug}/bookmarks
{"websiteLink":"websiteLink","_header":{},"reputation":5,"blocksCount":true,"posts":[{"upvotes":5,"pid":6,"timestampISO":"timestampISO","downvotes":9,"tid":7,"content":"content","uid":1,"deleted":true,"isMainPost":true,"topic":{"uid":8,"deleted":3,"postcount":6,"titleRaw":"titleRaw","mainPid":1,"title":"title","teaserPid":{},"tid":9,"slug":"slug","cid":6},"votes":9,"category":{"parentCid":6,"bgColor":"bgColor","color":"color","backgroundImage":{},"name":"name","icon":"icon","slug":"slug","cid":2,"imageClass":"imageClass"},"user":{"uid":6,"icon:bgColor":"icon:bgColor","icon:text":"icon:text","userslug":"userslug","picture":{},"username":"username","status":"status"},"timestamp":4},{"upvotes":5,"pid":6,"timestampISO":"timestampISO","downvotes":9,"tid":7,"content":"content","uid":1,"deleted":true,"isMainPost":true,"topic":{"uid":8,"deleted":3,"postcount":6,"titleRaw":"titleRaw","mainPid":1,"title":"title","teaserPid":{},"tid":9,"slug":"slug","cid":6},"votes":9,"category":{"parentCid":6,"bgColor":"bgColor","color":"color","backgroundImage":{},"name":"name","icon":"icon","slug":"slug","cid":2,"imageClass":"imageClass"},"user":{"uid":6,"icon:bgColor":"icon:bgColor","icon:text":"icon:text","userslug":"userslug","picture":{},"username":"username","status":"status"},"timestamp":4}],"sso":[{},{}],"icon:text":"icon:text","isGlobalModerator":true,"joindate":0,"profile_links":[{},{}],"reputation:disabled":true,"banned_until_readable":"banned_until_readable","allowCoverPicture":true,"isAdmin":true,"moderationNote":"moderationNote","ips":{},"latestPosts":[null,null],"aboutme":"aboutme","email:confirmed":true,"isTargetAdmin":true,"isAdminOrGlobalModerator":true,"emailClass":"emailClass","loggedIn":true,"downvote:disabled":true,"topiccount":2,"relative_path":"relative_path","isSelf":true,"breadcrumbs":[{},{}],"status":"status","birthday":"birthday","template":{},"showHidden":true,"yourid":1,"lastposttime":7,"isModerator":true,"signature":"signature","icon:bgColor":true,"canEdit":true,"flags":"flags","groupTitle":"groupTitle","isBlocked":true,"bestPosts":[null,null],"title":"title","widgets":{},"followingCount":2,"lastonlineISO":"lastonlineISO","email:disableEdit":true,"uid":"uid","groupTitleArray":["groupTitleArray","groupTitleArray"],"canChangePassword":true,"profileviews":1,"bodyClass":"bodyClass","cover:url":"cover:url","selectedGroup":[{},{}],"banned":true,"banned_until":4,"userslug":"userslug","followerCount":3,"email":"email","website":"website","isFollowing":true,"uploadedpicture":"uploadedpicture","canBan":true,"lastonline":6,"disableSignatures":true,"banned:expire":9,"groups":[{},{}],"username:disableEdit":true,"joindateISO":"joindateISO","url":"url","isSelfOrAdminOrGlobalModerator":true,"websiteName":"websiteName","hasPrivateChat":1,"isAdminOrGlobalModeratorOrModerator":true,"cover:position":"cover:position","postcount":5,"location":"location","fullname":"fullname","aboutmeParsed":"aboutmeParsed","age":7,"theirid":1,"username":"username"}
This api is used for fetching the user recent post details from nodebb.
/user/{userslug}/posts
{"websiteLink":"websiteLink","_header":{},"reputation":5,"blocksCount":true,"posts":[{"upvotes":5,"pid":6,"timestampISO":"timestampISO","downvotes":9,"tid":7,"content":"content","uid":1,"deleted":true,"isMainPost":true,"topic":{"uid":8,"deleted":3,"postcount":6,"titleRaw":"titleRaw","mainPid":1,"title":"title","teaserPid":{},"tid":9,"slug":"slug","cid":6},"votes":9,"category":{"parentCid":6,"bgColor":"bgColor","color":"color","backgroundImage":{},"name":"name","icon":"icon","slug":"slug","cid":2,"imageClass":"imageClass"},"user":{"uid":6,"icon:bgColor":"icon:bgColor","icon:text":"icon:text","userslug":"userslug","picture":{},"username":"username","status":"status"},"timestamp":4},{"upvotes":5,"pid":6,"timestampISO":"timestampISO","downvotes":9,"tid":7,"content":"content","uid":1,"deleted":true,"isMainPost":true,"topic":{"uid":8,"deleted":3,"postcount":6,"titleRaw":"titleRaw","mainPid":1,"title":"title","teaserPid":{},"tid":9,"slug":"slug","cid":6},"votes":9,"category":{"parentCid":6,"bgColor":"bgColor","color":"color","backgroundImage":{},"name":"name","icon":"icon","slug":"slug","cid":2,"imageClass":"imageClass"},"user":{"uid":6,"icon:bgColor":"icon:bgColor","icon:text":"icon:text","userslug":"userslug","picture":{},"username":"username","status":"status"},"timestamp":4}],"sso":[{},{}],"icon:text":"icon:text","isGlobalModerator":true,"joindate":0,"profile_links":[{},{}],"reputation:disabled":true,"banned_until_readable":"banned_until_readable","allowCoverPicture":true,"isAdmin":true,"moderationNote":"moderationNote","ips":{},"latestPosts":[null,null],"aboutme":"aboutme","email:confirmed":true,"isTargetAdmin":true,"isAdminOrGlobalModerator":true,"emailClass":"emailClass","loggedIn":true,"downvote:disabled":true,"topiccount":2,"relative_path":"relative_path","isSelf":true,"breadcrumbs":[{},{}],"status":"status","birthday":"birthday","template":{},"showHidden":true,"yourid":1,"lastposttime":7,"isModerator":true,"signature":"signature","icon:bgColor":true,"canEdit":true,"flags":"flags","groupTitle":"groupTitle","isBlocked":true,"bestPosts":[null,null],"title":"title","widgets":{},"followingCount":2,"lastonlineISO":"lastonlineISO","email:disableEdit":true,"uid":"uid","groupTitleArray":["groupTitleArray","groupTitleArray"],"canChangePassword":true,"profileviews":1,"bodyClass":"bodyClass","cover:url":"cover:url","selectedGroup":[{},{}],"banned":true,"banned_until":4,"userslug":"userslug","followerCount":3,"email":"email","website":"website","isFollowing":true,"uploadedpicture":"uploadedpicture","canBan":true,"lastonline":6,"disableSignatures":true,"banned:expire":9,"groups":[{},{}],"username:disableEdit":true,"joindateISO":"joindateISO","url":"url","isSelfOrAdminOrGlobalModerator":true,"websiteName":"websiteName","hasPrivateChat":1,"isAdminOrGlobalModeratorOrModerator":true,"cover:position":"cover:position","postcount":5,"location":"location","fullname":"fullname","aboutmeParsed":"aboutmeParsed","age":7,"theirid":1,"username":"username"}
This api is used for deleting user in nodebb.
/v2/users/{uid}
{"code":"code","payload":{}}
This api is used for creating the user in nodebb using write api plugin.
/v2/users
{"code":"code","payload":{"uid":0}}
This api is used for creating the user in nodebb usig Sunbird OIDC plugin.
/user/v1/create
This api is used to update user's profile information in nodebb.
/v2/users/{uid}
{"code":"code","payload":{}}