NoteBoard API

Get board list

GET /canvas/list (Get board list)

Headers

name	type	data type	description
Authorization	required	string	Bearer token

Query

name	type	data type	description
projectId	required	string	Project ID

Responses

http code	content-type	response
200	application/json	{ err: false, data: Array of Board details }
403	application/json	No project permission access

Example

 GET /canvas/list?project=614aa2a260318c20a6fed424

---

Get one board

GET /canvas/id (Get one board)

Headers

name	type	data type	description
Authorization	required	string	Bearer token

Parameters

name	type	data type	description
id	required	string	Board ID

Responses

http code	content-type	response
200	application/json	{ err: false, data: Board details }
403	application/json	No project permission access
404	application/json	Team Not found

Example

 GET /canvas/614aa2a260318c20a6fed424

---

GET board users

GET /canvas/id/users (Get board users)

Headers

name	type	data type	description
Authorization	required	string	Bearer token

Parameters

name	type	data type	description
id	required	string	Board ID

Body

name	type	data type	description
owner	required	string	Team leader User ID
shared	optional	string	Array of User ID

Responses

http code	content-type	response
200	application/json	{ err: false, data: { owner: User, shared: [
		{ read: boolean, write: boolean, user: User }
		] } }
403	application/json	No permission access
404	application/json	Board Not found

Example

 GET /canvas/unique-id

---

Update board users

PUT /canvas/id/users (Update board users)

Headers

name	type	data type	description
Authorization	required	string	Bearer token

Parameters

name	type	data type	description
id	required	string	Board ID

Body

name	type	data type	description
users	optional	string	Array of User ID

Responses

http code	content-type	response
200	application/json	{ err: false }
403	application/json	No permission access
404	application/json	Board Not found

Example

 PUT /board/unique-id/users
 {
     users: ['user-id-1','user-id-2']
 }

---

Update board background

POST /canvas/id/background (Update board background)

Headers

name	type	data type	description
Authorization	required	string	Bearer token

Parameters

name	type	data type	description
id	required	string	Board ID

Body

name	type	data type	description
file	require	string	File
project	require	string	Project ID

Responses

http code	content-type	response
200	application/json	{ err: false }
403	application/json	No permission access
404	application/json	Board Not found

---

Remove board background

POST /canvas/id/clearBackground (Remove board background)

Headers

name	type	data type	description
Authorization	required	string	Bearer token

Parameters

name	type	data type	description
id	required	string	Board ID

Responses

http code	content-type	response
200	application/json	{ err: false }
403	application/json	No permission access
404	application/json	Board Not found

---

Update board configs

PUT /canvas/id/config (Update board configs file)

Headers

name	type	data type	description
Authorization	required	string	Bearer token

Parameters

name	type	data type	description
id	required	string	Board ID

Body

name	type	data type	description
config	require	Object	key-value paired Object

Responses

http code	content-type	response
200	application/json	{ err: false }
403	application/json	No permission access
404	application/json	Board Not found
500	application/json	Internal Server Error