/
MA
mattermost
/
Focalboard Server
Search skmtc…
⌘K
Docs
Sign in
Sign in
APIs
Generators
Stacks
Projects
Docs
History
Schema
Checked 30m ago · Updated 4y ago
Details
Filter operations
get
Notifies admins for upgrade request.
post
/boards
post
/boards-and-blocks
delete
/boards-and-blocks
patch
/boards-and-blocks
get
/boards/{boardID}
delete
/boards/{boardID}
patch
/boards/{boardID}
get
Exports an archive of all blocks for one boards.
get
/boards/{boardID}/blocks
post
/boards/{boardID}/blocks
patch
/boards/{boardID}/blocks/
delete
/boards/{boardID}/blocks/{blockID}
patch
/boards/{boardID}/blocks/{blockID}
post
/boards/{boardID}/blocks/{blockID}/duplicate
post
/boards/{boardID}/blocks/{blockID}/undelete
get
Fetches cards for the specified board.
post
Creates a new card for the specified board.
post
/boards/{boardID}/duplicate
post
/boards/{boardID}/join
post
/boards/{boardID}/leave
get
/boards/{boardID}/members
post
/boards/{boardID}/members
put
/boards/{boardID}/members/{userID}
delete
/boards/{boardID}/members/{userID}
get
/boards/{boardID}/metadata
get
/boards/{boardID}/sharing
post
/boards/{boardID}/sharing
post
/boards/{boardID}/undelete
get
/boards/search
get
Fetches the specified card.
patch
Patches the specified card.
get
/clientConfig
get
/files/teams/{teamID}/{boardID}/{filename}
get
Responds with `Hello` if the web service is running.
get
Fetches the cloud limits of the server.
post
/login
post
/logout
get
Responds with server metadata if the web service is running.
post
/register
get
Fetches the statistic of the server.
post
Creates a subscription to a block for a user. The user will receive change notifications for the block.
delete
Deletes a subscription a user has for a a block. The user will no longer receive change notifications for the block.
get
Gets subscriptions for a user.
post
Onboards a user on Boards.
get
/teams
get
/teams/{teamID}
get
Exports an archive of all blocks for all the boards in a team.
post
Import an archive of boards.
get
/teams/{teamID}/boards
post
/teams/{teamID}/boards/{boardID}/files
get
/teams/{teamID}/boards/insights
get
/teams/{teamID}/boards/search
get
/teams/{teamID}/boards/search/linkable
get
/teams/{teamID}/categories
post
/teams/{teamID}/categories
put
/teams/{teamID}/categories/{categoryID}
delete
/teams/{teamID}/categories/{categoryID}
post
/teams/{teamID}/categories/{categoryID}/boards/{boardID}
get
/teams/{teamID}/channels
get
/teams/{teamID}/channels/{channelID}
post
/teams/{teamID}/regenerate_signup_token
get
/teams/{teamID}/templates
get
/teams/{teamID}/users
post
/users
get
/users/{userID}
post
/users/{userID}/changepassword
patch
/users/{userID}/config
get
/users/me
get
/users/me/boards/insights
get
/users/me/config
get
/users/me/memberships
Gets subscriptions for a user.
get
/subscriptions/{subscriberID}
Path parameters
subscriberID
string
required
Subscriber ID
Response
success
User[]
required
{"stackTrail":"components:schemas:User","oasType":"schema","type":"unknown","description":"User is a user","extensionFields":{"x-go-package":"github.com/mattermost/focalboard/server/model"}}
Changes