API docs by Redocly

StickyBoard API (v1)

Download OpenAPI specification :

URL: https://aedev.pro

REST API for StickyBoard cross-platform workspace (Academic Project)

Auth

/api/Auth/register

Authorizations:
(BearerApiKey)
Request Body schema:
email
string or null
password
string or null
displayName
string or null
inviteToken
string or null

Responses

Request samples

Content type
{
  • "email": "string",
  • "password": "string",
  • "displayName": "string",
  • "inviteToken": "string"
}

Response samples

Content type
{
  • "success": true,
  • "message": "string",
  • "data": {
    }
}

/api/Auth/login

Authorizations:
(BearerApiKey)
Request Body schema:
email
string or null
password
string or null

Responses

Request samples

Content type
{
  • "email": "string",
  • "password": "string"
}

Response samples

Content type
{
  • "success": true,
  • "message": "string",
  • "data": {
    }
}

/api/Auth/refresh

Authorizations:
(BearerApiKey)
Request Body schema:
refreshToken
string or null

Responses

Request samples

Content type
{
  • "refreshToken": "string"
}

Response samples

Content type
{
  • "success": true,
  • "message": "string",
  • "data": {
    }
}

/api/Auth/logout

Authorizations:
(BearerApiKey)

Responses

Response samples

Content type
{
  • "success": true,
  • "message": "string",
  • "data": null
}

/api/Auth/me

Authorizations:
(BearerApiKey)

Responses

Response samples

Content type
{
  • "success": true,
  • "message": "string",
  • "data": {
    }
}

BoardFolder

/api/folders

Authorizations:
(BearerApiKey)

Responses

Response samples

Content type
application/json
{ }

/api/folders

Authorizations:
(BearerApiKey)
Request Body schema:
name
string or null
orgId
string or null <uuid >
icon
string or null
color
string or null
meta
any or null

Responses

Request samples

Content type
{
  • "name": "string",
  • "orgId": "25b2c2d5-a7fc-47d0-89e4-8709a1560bfa",
  • "icon": "string",
  • "color": "string",
  • "meta": null
}

Response samples

Content type
application/json
{ }

/api/folders/{id}

Authorizations:
(BearerApiKey)
path Parameters
id
required
string <uuid >
Request Body schema:
name
string or null
icon
string or null
color
string or null
meta
any or null

Responses

Request samples

Content type
{
  • "name": "string",
  • "icon": "string",
  • "color": "string",
  • "meta": null
}

Response samples

Content type
application/json
{ }

/api/folders/{id}

Authorizations:
(BearerApiKey)
path Parameters
id
required
string <uuid >

Responses

Response samples

Content type
application/json
{ }

BoardMessage

/api/boards/{boardId}/messages

Authorizations:
(BearerApiKey)
path Parameters
boardId
required
string <uuid >

Responses

Response samples

Content type
application/json
{ }

/api/boards/{boardId}/messages

Authorizations:
(BearerApiKey)
path Parameters
boardId
required
string <uuid >
Request Body schema:
content
string or null

Responses

Request samples

Content type
{
  • "content": "string"
}

Response samples

Content type
application/json
{ }

Boards

/api/Boards/mine

Authorizations:
(BearerApiKey)

Responses

Response samples

Content type
application/json
{ }

/api/Boards/accessible

Authorizations:
(BearerApiKey)

Responses

Response samples

Content type
application/json
{ }

/api/Boards/search

Authorizations:
(BearerApiKey)
query Parameters
keyword
string

Responses

Response samples

Content type
application/json
{ }

/api/Boards/{id}

Authorizations:
(BearerApiKey)
path Parameters
id
required
string <uuid >

Responses

Response samples

Content type
application/json
{ }

/api/Boards/{id}

Authorizations:
(BearerApiKey)
path Parameters
id
required
string <uuid >
Request Body schema:
title
string or null
visibility
integer <int32 > ( BoardVisibility)
Enum: 0 1 2
folderId
string or null <uuid >
theme
any or null
meta
any or null

Responses

Request samples

Content type
{
  • "title": "string",
  • "visibility": 0,
  • "folderId": "5b6379a4-2a6c-4085-b184-45838a3b8e7e",
  • "theme": null,
  • "meta": null
}

Response samples

Content type
application/json
{ }

/api/Boards/{id}

Authorizations:
(BearerApiKey)
path Parameters
id
required
string <uuid >

Responses

Response samples

Content type
application/json
{ }

/api/Boards

Authorizations:
(BearerApiKey)
Request Body schema:
title
string or null
visibility
integer <int32 > ( BoardVisibility)
Enum: 0 1 2
orgId
string or null <uuid >
folderId
string or null <uuid >
theme
any or null
meta
any or null

Responses

Request samples

Content type
{
  • "title": "string",
  • "visibility": 0,
  • "orgId": "25b2c2d5-a7fc-47d0-89e4-8709a1560bfa",
  • "folderId": "5b6379a4-2a6c-4085-b184-45838a3b8e7e",
  • "theme": null,
  • "meta": null
}

Response samples

Content type
application/json
{ }

/api/Boards/{id}/rename

Authorizations:
(BearerApiKey)
path Parameters
id
required
string <uuid >
Request Body schema:
title
string or null

Responses

Request samples

Content type
{
  • "title": "string"
}

Response samples

Content type
application/json
{ }

/api/Boards/{id}/folder

Authorizations:
(BearerApiKey)
path Parameters
id
required
string <uuid >
Request Body schema:
folderId
string or null <uuid >

Responses

Request samples

Content type
{
  • "folderId": "5b6379a4-2a6c-4085-b184-45838a3b8e7e"
}

Response samples

Content type
application/json
{ }

/api/Boards/{id}/org

Authorizations:
(BearerApiKey)
path Parameters
id
required
string <uuid >
Request Body schema:
orgId
string or null <uuid >

Responses

Request samples

Content type
{
  • "orgId": "25b2c2d5-a7fc-47d0-89e4-8709a1560bfa"
}

Response samples

Content type
application/json
{ }

CardComment

/api/cards/{cardId}/comments

Authorizations:
(BearerApiKey)
path Parameters
cardId
required
string <uuid >

Responses

Response samples

Content type
application/json
{ }

/api/cards/{cardId}/comments

Authorizations:
(BearerApiKey)
path Parameters
cardId
required
string <uuid >
Request Body schema:
content
string or null

Responses

Request samples

Content type
{
  • "content": "string"
}

Response samples

Content type
application/json
{ }

Cards

/api/cards/{id}

Authorizations:
(BearerApiKey)
path Parameters
id
required
string <uuid >

Responses

Response samples

Content type
application/json
{ }

/api/cards/{id}

Authorizations:
(BearerApiKey)
path Parameters
id
required
string <uuid >
Request Body schema:
title
string or null
content
any or null
tags
Array of strings or null
status
integer <int32 > ( CardStatus)
Enum: 0 1 2 3 4
priority
integer <int32 >
assigneeId
string or null <uuid >
dueDate
string or null <date-time >
startTime
string or null <date-time >
endTime
string or null <date-time >
sectionId
string or null <uuid >
tabId
string or null <uuid >

Responses

Request samples

Content type
{
  • "title": "string",
  • "content": null,
  • "tags": [
    ],
  • "status": 0,
  • "priority": 0,
  • "assigneeId": "665a9750-71bd-4b96-bacd-9efa4ae022dd",
  • "dueDate": "2019-08-24T14:15:22Z",
  • "startTime": "2019-08-24T14:15:22Z",
  • "endTime": "2019-08-24T14:15:22Z",
  • "sectionId": "e886b9ca-b5a6-42e4-892d-0b160851d7c9",
  • "tabId": "f4c36190-e358-41c0-b3ad-58e9e89eba63"
}

Response samples

Content type
application/json
{ }

/api/cards/{id}

Authorizations:
(BearerApiKey)
path Parameters
id
required
string <uuid >

Responses

Response samples

Content type
application/json
{ }

/api/cards/tab/{tabId}

Authorizations:
(BearerApiKey)
path Parameters
tabId
required
string <uuid >

Responses

Response samples

Content type
application/json
{ }

/api/cards/section/{sectionId}

Authorizations:
(BearerApiKey)
path Parameters
sectionId
required
string <uuid >

Responses

Response samples

Content type
application/json
{ }

/api/cards

Authorizations:
(BearerApiKey)
Request Body schema:
boardId
string <uuid >
tabId
string <uuid >
sectionId
string or null <uuid >
type
integer <int32 > ( CardType)
Enum: 0 1 2 3
title
string or null
content
any or null
tags
Array of strings or null
priority
integer <int32 >
assigneeId
string or null <uuid >
dueDate
string or null <date-time >

Responses

Request samples

Content type
{
  • "boardId": "a654038e-9287-48a2-acfd-90b8cfa8b1f4",
  • "tabId": "f4c36190-e358-41c0-b3ad-58e9e89eba63",
  • "sectionId": "e886b9ca-b5a6-42e4-892d-0b160851d7c9",
  • "type": 0,
  • "title": "string",
  • "content": null,
  • "tags": [
    ],
  • "priority": 0,
  • "assigneeId": "665a9750-71bd-4b96-bacd-9efa4ae022dd",
  • "dueDate": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{ }

Invites

/api/Invites

Authorizations:
(BearerApiKey)
Request Body schema:
email
string or null
boardId
string or null <uuid >
orgId
string or null <uuid >
boardRole
integer <int32 > ( BoardRole)
Enum: 0 1 2 3
orgRole
integer <int32 > ( OrgRole)
Enum: 0 1 2 3 4
expiresInDays
integer or null <int32 >

Responses

Request samples

Content type
{
  • "email": "string",
  • "boardId": "a654038e-9287-48a2-acfd-90b8cfa8b1f4",
  • "orgId": "25b2c2d5-a7fc-47d0-89e4-8709a1560bfa",
  • "boardRole": 0,
  • "orgRole": 0,
  • "expiresInDays": 0
}

Response samples

Content type
{
  • "success": true,
  • "message": "string",
  • "data": {
    }
}

/api/Invites/redeem

Authorizations:
(BearerApiKey)
Request Body schema:
token
string or null

Responses

Request samples

Content type
{
  • "token": "string"
}

Response samples

Content type
{
  • "success": true,
  • "message": "string",
  • "data": null
}

/api/Invites/received

Authorizations:
(BearerApiKey)

Responses

Response samples

Content type
{
  • "success": true,
  • "message": "string",
  • "data": [
    ]
}

/api/Invites/sent

Authorizations:
(BearerApiKey)

Responses

Response samples

Content type
{
  • "success": true,
  • "message": "string",
  • "data": [
    ]
}

/api/Invites/{inviteId}

Authorizations:
(BearerApiKey)
path Parameters
inviteId
required
string <uuid >

Responses

Response samples

Content type
{
  • "success": true,
  • "message": "string",
  • "data": null
}

/api/Invites/public/{token}

Authorizations:
(BearerApiKey)
path Parameters
token
required
string

Responses

Response samples

Content type
{
  • "success": true,
  • "message": "string",
  • "data": {
    }
}

Messages

/api/messages

Authorizations:
(BearerApiKey)

Responses

Response samples

Content type
application/json
{ }

/api/messages

Authorizations:
(BearerApiKey)
Request Body schema:
receiverId
string <uuid >
subject
string or null
body
string or null
type
integer <int32 > ( MessageType)
Enum: 0 1 2 3
relatedBoardId
string or null <uuid >
relatedOrgId
string or null <uuid >

Responses

Request samples

Content type
{
  • "receiverId": "2ec2e5a9-5968-4568-baf3-a525f7f8b9a6",
  • "subject": "string",
  • "body": "string",
  • "type": 0,
  • "relatedBoardId": "07a1ce0d-49dc-4838-9256-25b3a6b7ff40",
  • "relatedOrgId": "21c94b7d-954c-44b1-a551-7944ee3bfee4"
}

Response samples

Content type
application/json
{ }

/api/messages/unread-count

Authorizations:
(BearerApiKey)

Responses

Response samples

Content type
application/json
{ }

/api/messages/{id}/status

Authorizations:
(BearerApiKey)
path Parameters
id
required
string <uuid >
Request Body schema:
status
integer <int32 > ( MessageStatus)
Enum: 0 1 2

Responses

Request samples

Content type
{
  • "status": 0
}

Response samples

Content type
application/json
{ }

/api/messages/{id}

Authorizations:
(BearerApiKey)
path Parameters
id
required
string <uuid >

Responses

Response samples

Content type
application/json
{ }

Organizations

/api/Organizations

Authorizations:
(BearerApiKey)

Responses

Response samples

Content type
{
  • "success": true,
  • "message": "string",
  • "data": [
    ]
}

/api/Organizations

Authorizations:
(BearerApiKey)
Request Body schema:
name
string or null

Responses

Request samples

Content type
{
  • "name": "string"
}

Response samples

Content type
{
  • "success": true,
  • "message": "string",
  • "data": null
}

/api/Organizations/owned

Authorizations:
(BearerApiKey)

Responses

Response samples

Content type
{
  • "success": true,
  • "message": "string",
  • "data": [
    ]
}

/api/Organizations/{orgId}

Authorizations:
(BearerApiKey)
path Parameters
orgId
required
string <uuid >
Request Body schema:
name
string or null

Responses

Request samples

Content type
{
  • "name": "string"
}

Response samples

Content type
{
  • "success": true,
  • "message": "string",
  • "data": null
}

/api/Organizations/{orgId}

Authorizations:
(BearerApiKey)
path Parameters
orgId
required
string <uuid >

Responses

Response samples

Content type
{
  • "success": true,
  • "message": "string",
  • "data": null
}

/api/Organizations/{orgId}/members

Authorizations:
(BearerApiKey)
path Parameters
orgId
required
string <uuid >

Responses

Response samples

Content type
{
  • "success": true,
  • "message": "string",
  • "data": [
    ]
}

/api/Organizations/{orgId}/members/{userId}

Authorizations:
(BearerApiKey)
path Parameters
orgId
required
string <uuid >
userId
required
string <uuid >
query Parameters
role
integer <int32 > (OrgRole )
Enum: 0 1 2 3 4

Responses

Response samples

Content type
{
  • "success": true,
  • "message": "string",
  • "data": null
}

/api/Organizations/{orgId}/members/{userId}

Authorizations:
(BearerApiKey)
path Parameters
orgId
required
string <uuid >
userId
required
string <uuid >
query Parameters
role
integer <int32 > (OrgRole )
Enum: 0 1 2 3 4

Responses

Response samples

Content type
{
  • "success": true,
  • "message": "string",
  • "data": null
}

/api/Organizations/{orgId}/members/{userId}

Authorizations:
(BearerApiKey)
path Parameters
orgId
required
string <uuid >
userId
required
string <uuid >

Responses

Response samples

Content type
{
  • "success": true,
  • "message": "string",
  • "data": null
}

Permissions

/api/boards/{boardId}/permissions

Authorizations:
(BearerApiKey)
path Parameters
boardId
required
string <uuid >

Responses

Response samples

Content type
application/json
{ }

/api/boards/{boardId}/permissions

Authorizations:
(BearerApiKey)
path Parameters
boardId
required
string <uuid >
Request Body schema:
userId
string <uuid >
role
integer <int32 > ( BoardRole)
Enum: 0 1 2 3

Responses

Request samples

Content type
{
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "role": 0
}

Response samples

Content type
application/json
{ }

/api/users/{userId}/boards

Authorizations:
(BearerApiKey)
path Parameters
userId
required
string <uuid >

Responses

Response samples

Content type
application/json
{ }

/api/boards/{boardId}/permissions/{userId}

Authorizations:
(BearerApiKey)
path Parameters
boardId
required
string <uuid >
userId
required
string <uuid >
Request Body schema:
role
integer <int32 > ( BoardRole)
Enum: 0 1 2 3

Responses

Request samples

Content type
{
  • "role": 0
}

Response samples

Content type
application/json
{ }

/api/boards/{boardId}/permissions/{userId}

Authorizations:
(BearerApiKey)
path Parameters
boardId
required
string <uuid >
userId
required
string <uuid >

Responses

Response samples

Content type
application/json
{ }

Sections

/api/Sections/tab/{tabId}

Authorizations:
(BearerApiKey)
path Parameters
tabId
required
string <uuid >

Responses

Response samples

Content type
{
  • "success": true,
  • "message": "string",
  • "data": [
    ]
}

/api/Sections

Authorizations:
(BearerApiKey)
Request Body schema:
tabId
string <uuid >
parentSectionId
string or null <uuid >
title
string or null
position
integer <int32 >
layout
any or null

Responses

Request samples

Content type
{
  • "tabId": "f4c36190-e358-41c0-b3ad-58e9e89eba63",
  • "parentSectionId": "93ddda8b-06e9-4976-835f-213e1f39dfab",
  • "title": "string",
  • "position": 0,
  • "layout": null
}

Response samples

Content type
{
  • "success": true,
  • "message": "string",
  • "data": null
}

/api/Sections/{id}

Authorizations:
(BearerApiKey)
path Parameters
id
required
string <uuid >
Request Body schema:
title
string or null
position
integer <int32 >
parentSectionId
string or null <uuid >
layout
any or null

Responses

Request samples

Content type
{
  • "title": "string",
  • "position": 0,
  • "parentSectionId": "93ddda8b-06e9-4976-835f-213e1f39dfab",
  • "layout": null
}

Response samples

Content type
{
  • "success": true,
  • "message": "string",
  • "data": null
}

/api/Sections/{id}

Authorizations:
(BearerApiKey)
path Parameters
id
required
string <uuid >

Responses

Response samples

Content type
{
  • "success": true,
  • "message": "string",
  • "data": null
}

/api/Sections/{id}/move

Authorizations:
(BearerApiKey)
path Parameters
id
required
string <uuid >
Request Body schema:
newPosition
integer <int32 >
parentSectionId
string or null <uuid >

Responses

Request samples

Content type
{
  • "newPosition": 0,
  • "parentSectionId": "93ddda8b-06e9-4976-835f-213e1f39dfab"
}

Response samples

Content type
{
  • "success": true,
  • "message": "string",
  • "data": null
}

Tabs

/api/Tabs/board/{boardId}

Authorizations:
(BearerApiKey)
path Parameters
boardId
required
string <uuid >

Responses

Response samples

Content type
{
  • "success": true,
  • "message": "string",
  • "data": [
    ]
}

/api/Tabs

Authorizations:
(BearerApiKey)
Request Body schema:
boardId
string <uuid >
title
string or null
tabType
integer <int32 > ( TabType)
Enum: 0 1 2 3 4 5 6 7
position
integer <int32 >
layout
any or null

Responses

Request samples

Content type
{
  • "boardId": "a654038e-9287-48a2-acfd-90b8cfa8b1f4",
  • "title": "string",
  • "tabType": 0,
  • "position": 0,
  • "layout": null
}

Response samples

Content type
{
  • "success": true,
  • "message": "string",
  • "data": null
}

/api/Tabs/{id}

Authorizations:
(BearerApiKey)
path Parameters
id
required
string <uuid >
Request Body schema:
title
string or null
tabType
integer <int32 > ( TabType)
Enum: 0 1 2 3 4 5 6 7
position
integer <int32 >
layout
any or null

Responses

Request samples

Content type
{
  • "title": "string",
  • "tabType": 0,
  • "position": 0,
  • "layout": null
}

Response samples

Content type
{
  • "success": true,
  • "message": "string",
  • "data": null
}

/api/Tabs/{id}

Authorizations:
(BearerApiKey)
path Parameters
id
required
string <uuid >

Responses

Response samples

Content type
{
  • "success": true,
  • "message": "string",
  • "data": null
}

/api/Tabs/{id}/move

Authorizations:
(BearerApiKey)
path Parameters
id
required
string <uuid >
Request Body schema:
newPosition
integer <int32 >

Responses

Request samples

Content type
{
  • "newPosition": 0
}

Response samples

Content type
{
  • "success": true,
  • "message": "string",
  • "data": null
}

UserRelations

/api/UserRelations

Authorizations:
(BearerApiKey)

Responses

Response samples

Content type
{
  • "success": true,
  • "message": "string",
  • "data": [
    ]
}

/api/UserRelations

Authorizations:
(BearerApiKey)
Request Body schema:
friendId
string <uuid >

Responses

Request samples

Content type
{
  • "friendId": "4bd6e55f-1d02-40eb-85a5-4e8b566403a4"
}

Response samples

Content type
{
  • "success": true,
  • "message": "string",
  • "data": null
}

/api/UserRelations/{friendId}

Authorizations:
(BearerApiKey)
path Parameters
friendId
required
string <uuid >
Request Body schema:
status
integer <int32 > ( RelationStatus)
Enum: 0 1 2

Responses

Request samples

Content type
{
  • "status": 0
}

Response samples

Content type
{
  • "success": true,
  • "message": "string",
  • "data": null
}

/api/UserRelations/{friendId}

Authorizations:
(BearerApiKey)
path Parameters
friendId
required
string <uuid >

Responses

Response samples

Content type
{
  • "success": true,
  • "message": "string",
  • "data": null
}

Users

/api/Users/me

Authorizations:
(BearerApiKey)

Responses

Response samples

Content type
{
  • "success": true,
  • "message": "string",
  • "data": {
    }
}

/api/Users/me

Authorizations:
(BearerApiKey)
Request Body schema:
displayName
string or null
avatarUrl
string or null
prefs
any or null

Responses

Request samples

Content type
{
  • "displayName": "string",
  • "avatarUrl": "string",
  • "prefs": null
}

Response samples

Content type
{
  • "success": true,
  • "message": "string",
  • "data": null
}

/api/Users/me/password

Authorizations:
(BearerApiKey)
Request Body schema:
oldPassword
string or null
newPassword
string or null

Responses

Request samples

Content type
{
  • "oldPassword": "string",
  • "newPassword": "string"
}

Response samples

Content type
{
  • "success": true,
  • "message": "string",
  • "data": null
}

/api/Users/search

Authorizations:
(BearerApiKey)
query Parameters
q
string

Responses

Response samples

Content type
{
  • "success": true,
  • "message": "string",
  • "data": [
    ]
}

/api/Users/{id}

Authorizations:
(BearerApiKey)
path Parameters
id
required
string <uuid >

Responses

Response samples

Content type
{
  • "success": true,
  • "message": "string",
  • "data": {
    }
}

/api/Users/{id}

Authorizations:
(BearerApiKey)
path Parameters
id
required
string <uuid >

Responses

Response samples

Content type
{
  • "success": true,
  • "message": "string",
  • "data": null
}

/api/Users/{id}/role

Authorizations:
(BearerApiKey)
path Parameters
id
required
string <uuid >
query Parameters
role
integer <int32 > (UserRole )
Enum: 0 1 2

Responses

Response samples

Content type
{
  • "success": true,
  • "message": "string",
  • "data": null
}