Skip to content

API Overview

Global

MethodEndpoint PathDescription
GET/status.json
/api/fresns/v1/global/status
Client Status
GET/api/fresns/v1/global/configsConfigs
GET/api/fresns/v1/global/language-packLanguage Pack
GET/api/fresns/v1/global/channelsExtend Channels
GET/api/fresns/v1/global/{type}/archivesExtend Archives
GET/api/fresns/v1/global/{type}/content-typesContent Types
GET/api/fresns/v1/global/rolesUser Roles
GET/api/fresns/v1/global/stickersStickers

Common

MethodEndpoint PathDescription
GET/api/fresns/v1/common/ip-infoIP Information
GET/api/fresns/v1/common/input-tipsInput Tips
GET/api/fresns/v1/common/callbackApp or Plugin Callback
POST/api/fresns/v1/common/cmd-wordCommand Word Request
GET/api/fresns/v1/common/file/storage-tokenFile: Storage Token
POST/api/fresns/v1/common/file/uploadsFile: Uploads
PATCH/api/fresns/v1/common/file/{fid}/warningFile: Update Warning
GET/api/fresns/v1/common/file/{fid}/linkFile: Download Link
GET/api/fresns/v1/common/file/{fid}/usersFile: Download Users

Account

MethodEndpoint PathDescription
POST/api/fresns/v1/account/auth-tokenCreate Account Token (Login)
DELETE/api/fresns/v1/account/auth-tokenDelete Account Token (Logout)
GET/api/fresns/v1/account/detailAccount Detail
GET/api/fresns/v1/account/wallet-recordsWallet Records

User

Function

MethodEndpoint PathDescription
POST/api/fresns/v1/user/auth-tokenCreate User Token (Login)
GET/api/fresns/v1/user/overviewOverview
GET/api/fresns/v1/user/extcredits-recordsExtcredits Records
PATCH/api/fresns/v1/user/profileEdit Profile
PATCH/api/fresns/v1/user/device-tokenUpdate Device Token
POST/api/fresns/v1/user/markMark
PATCH/api/fresns/v1/user/mark-noteMark Note
POST/api/fresns/v1/user/extend-actionExtend Action

Interactive

MethodEndpoint PathDescription
GET/api/fresns/v1/user/listUser List
GET/api/fresns/v1/user/{uidOrUsername}/detailUser Detail
GET/api/fresns/v1/user/{uidOrUsername}/followers-you-followFollowers You Know
GET/api/fresns/v1/user/{uidOrUsername}/interaction/{type}User Interaction Users
GET/api/fresns/v1/user/{uidOrUsername}/mark/{markType}/{listType}User Mark List

Message

Notification

MethodEndpoint PathDescription
GET/api/fresns/v1/notification/listList
PATCH/api/fresns/v1/notification/read-statusMark As Read
DELETE/api/fresns/v1/notification/messagesDelete Messages

Conversation

MethodEndpoint PathDescription
GET/api/fresns/v1/conversation/listList
GET/api/fresns/v1/conversation/{uidOrUsername}/detailDetail
GET/api/fresns/v1/conversation/{uidOrUsername}/messagesMessages
PATCH/api/fresns/v1/conversation/{uidOrUsername}/pinPin Conversation
PATCH/api/fresns/v1/conversation/{uidOrUsername}/read-statusMark As Read
DELETE/api/fresns/v1/conversation/{uidOrUsername}Delete Conversation or Messages
POST/api/fresns/v1/conversation/messageSend Message

Group

MethodEndpoint PathDescription
GET/api/fresns/v1/group/treeGroup Tree List
GET/api/fresns/v1/group/listGroup List
GET/api/fresns/v1/group/{gid}/detailGroup Detail
GET/api/fresns/v1/group/{gid}/creatorGroup Creator
GET/api/fresns/v1/group/{gid}/adminsGroup Admins
GET/api/fresns/v1/group/{gid}/interaction/{type}Group Interaction Users

Hashtag

MethodEndpoint PathDescription
GET/api/fresns/v1/hashtag/listHashtag List
GET/api/fresns/v1/hashtag/{htid}/detailHashtag Detail
GET/api/fresns/v1/hashtag/{htid}/interaction/{type}Hashtag Interaction Users

Geotag

MethodEndpoint PathDescription
GET/api/fresns/v1/geotag/listGeotag List
GET/api/fresns/v1/geotag/{gtid}/detailGeotag Detail
GET/api/fresns/v1/geotag/{gtid}/interaction/{type}Geotag Interaction Users

Post

MethodEndpoint PathDescription
GET/api/fresns/v1/post/listPost List
GET/api/fresns/v1/post/timelinesPost List by Timelines
GET/api/fresns/v1/post/nearbyPost List by Nearby
GET/api/fresns/v1/post/{pid}/detailPost Detail
GET/api/fresns/v1/post/{pid}/interaction/{type}Post Interaction Users
GET/api/fresns/v1/post/{pid}/usersPost Associated Users
GET/api/fresns/v1/post/{pid}/quotesPost Quote It List
GET/api/fresns/v1/post/{pid}/historiesPost Histories
GET/api/fresns/v1/post/history/{hpid}/detailPost History Detail
DELETE/api/fresns/v1/post/{pid}Delete

Comment

MethodEndpoint PathDescription
GET/api/fresns/v1/comment/listComment List
GET/api/fresns/v1/comment/timelinesComment List by Timelines
GET/api/fresns/v1/comment/nearbyComment List by Nearby
GET/api/fresns/v1/comment/{cid}/detailComment Detail
GET/api/fresns/v1/comment/{cid}/interaction/{type}Comment Interaction Users
GET/api/fresns/v1/comment/{cid}/historiesComment Histories
GET/api/fresns/v1/comment/history/{hcid}/detailComment History Detail
DELETE/api/fresns/v1/comment/{cid}Delete

Editor

MethodEndpoint PathDescription
GET/api/fresns/v1/editor/{type}/configsEditor Configs
POST/api/fresns/v1/editor/{type}/publishQuick Publish
POST/api/fresns/v1/editor/{type}/edit/{fsid}Edit Post or Comment
POST/api/fresns/v1/editor/{type}/draftDraft: Create
GET/api/fresns/v1/editor/{type}/draftsDraft: List
GET/api/fresns/v1/editor/{type}/draft/{did}Draft: Detail
PATCH/api/fresns/v1/editor/{type}/draft/{did}Draft: Update
POST/api/fresns/v1/editor/{type}/draft/{did}Draft: Publish
PUT/api/fresns/v1/editor/{type}/draft/{did}Draft: Recall (Draft under review)
DELETE/api/fresns/v1/editor/{type}/draft/{did}Draft: Delete
MethodEndpoint PathDescription
GET/api/fresns/v1/search/usersSearch Users
GET/api/fresns/v1/search/groupsSearch Groups
GET/api/fresns/v1/search/hashtagsSearch Hashtags
GET/api/fresns/v1/search/geotagsSearch Geotags
GET/api/fresns/v1/search/postsSearch Posts
GET/api/fresns/v1/search/commentsSearch Comments

Released under the Apache-2.0 License