Nexboard Public API V1 (1.0.0)

Download OpenAPI specification:Download

Authentication

checkToken

Security Scheme Type	API Key
Query parameter name:	token

boards

Get board by ID

Authorizations:

checkToken

path Parameters

boardId

required

integer <int64>

ID of board to get

Responses

200

board

401

no token, board id in request or no authorization for board

get /boards/{boardId}

Localhost development server (uses local data)

http://localhost:7000/api/v1/public/boards/{boardId}

Production server (uses live data)

http://nexboard.nexenio.com/portal/api/public/boards/{boardId}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"title": "string",
"description": "string",
"creationUser": 0,
"projectId": 0,
"isTemplate": 0,
"key": "string",
"meta": "string",
"id": 0,
"publicLink": "string",
"preview": "string",
"image": "string",
"creationUserName": "string",
"pubKey": "string",
"pubKeyExpiry": 0,
"pubKeyRight": "string",
"lastModified": 0,
"creationDate": 0,
"isPublic": true,
"tags": [ ]
}

Delete board

Authorizations:

checkToken

path Parameters

boardId

required

integer <int64>

ID of board to delete

Responses

200

status

401

no token, board id in request or no authorization for board

delete /boards/{boardId}

Localhost development server (uses local data)

http://localhost:7000/api/v1/public/boards/{boardId}

Production server (uses live data)

http://nexboard.nexenio.com/portal/api/public/boards/{boardId}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"deletedBoardId": 0
}

Create copy of a board given by ID at the given ti

Create copy of a board given by ID at the given timestamp.

Authorizations:

checkToken

path Parameters

boardId

required

string

ID of board to copy

Request Body schema: application/json

Unix Timestamp in seconds. Default is set to the current time.

integer <int64>

Responses

200

new created board after copying whiteboard elements

401

no token, no board id in request or no authorization for board

post /boards/{boardId}/copy

Localhost development server (uses local data)

http://localhost:7000/api/v1/public/boards/{boardId}/copy

Production server (uses live data)

http://nexboard.nexenio.com/portal/api/public/boards/{boardId}/copy

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

0

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"title": "string",
"description": "string",
"creationUser": 0,
"projectId": 0,
"isTemplate": 0,
"key": "string",
"meta": "string",
"id": 0,
"publicLink": "string",
"preview": "string",
"image": "string",
"creationUserName": "string",
"pubKey": "string",
"pubKeyExpiry": 0,
"pubKeyRight": "string",
"lastModified": 0,
"creationDate": 0,
"isPublic": true,
"tags": [ ]
}

Post board

Authorizations:

checkToken

Request Body schema: application/json

Board

title required	string
description	string
creationUser	integer <int64>
projectId	integer <int64>
isTemplate	integer <int64>
key	string
meta	string
id	integer <int64>
publicLink	string
preview	string
image	string
creationUserName	string
pubKey	string
pubKeyExpiry	integer <int64>
pubKeyRight	string
lastModified	integer <int64>
creationDate	integer <int64>
isPublic	boolean
tags	array

Responses

200

full board object

401

no token in request

post /boards

Localhost development server (uses local data)

http://localhost:7000/api/v1/public/boards

Production server (uses live data)

http://nexboard.nexenio.com/portal/api/public/boards

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"title": "string",
"description": "string",
"creationUser": 0,
"projectId": 0,
"isTemplate": 0,
"key": "string",
"meta": "string",
"id": 0,
"publicLink": "string",
"preview": "string",
"image": "string",
"creationUserName": "string",
"pubKey": "string",
"pubKeyExpiry": 0,
"pubKeyRight": "string",
"lastModified": 0,
"creationDate": 0,
"isPublic": true,
"tags": [ ]
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"title": "string",
"description": "string",
"creationUser": 0,
"projectId": 0,
"isTemplate": 0,
"key": "string",
"meta": "string",
"id": 0,
"publicLink": "string",
"preview": "string",
"image": "string",
"creationUserName": "string",
"pubKey": "string",
"pubKeyExpiry": 0,
"pubKeyRight": "string",
"lastModified": 0,
"creationDate": 0,
"isPublic": true,
"tags": [ ]
}

Post image to board

Authorizations:

checkToken

path Parameters

boardId

required

integer <int64>

ID of board to post image

Request Body schema: multipart/form-data

Board

image

string <binary>

Responses

200

status

401

no token, board id in request or no authorization for board

post /boards/images/{boardId}

Localhost development server (uses local data)

http://localhost:7000/api/v1/public/boards/images/{boardId}

Production server (uses live data)

http://nexboard.nexenio.com/portal/api/public/boards/images/{boardId}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"boardId": 0
}

Publish board

Authorizations:

checkToken

path Parameters

boardId

required

integer <int64>

ID of board to publish

Request Body schema: application/json

emails	Array of strings <email> list of emails to invite
email	string <email>
name	string

Responses

200

status

401

no token, board id in request or no authorization for board

put /boards/{boardId}/publish

Localhost development server (uses local data)

http://localhost:7000/api/v1/public/boards/{boardId}/publish

Production server (uses live data)

http://nexboard.nexenio.com/portal/api/public/boards/{boardId}/publish

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"emails": 
["user@example.com"
],
"email": "user@example.com",
"name": "string"
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"boardId": 0,
"invitees": 
["user@example.com"
]
}

health

Status of the API

Responses

200

API online

get /status

Localhost development server (uses local data)

http://localhost:7000/api/v1/public/status

Production server (uses live data)

http://nexboard.nexenio.com/portal/api/public/status