RestAPI

PixelPaper's API allows you to easily manage user's boards from your back-end, using your private API key. You can find this here.

Available Endpoints

A board is an existing whiteboard that one of your users can join. You're free to create as many boards as you'd like. You can currently create, delete and view your boards using the API.

GET https://hq.pixelpaper.io/api/board
GET https://hq.pixelpaper.io/api/board/{id}
POST https://hq.pixelpaper.io/api/board
DELETE https://hq.pixelpaper.io/api/board/{id}

Authenticating with PixelPaper

You can use your Private API Token to communicate with PixelPaper's REST API. You just need to include this token in your request as a bearer token.

Add the header: 'Authorization' => 'Bearer [your-api-token]' to all requests.

Create a Board

You don't need to pass any parameters in to create a board. We'll randomly generate a room ID for you, which we'll then return in the response. We'll return an object containing the room_id of the newly created board. This can then be used in our PaperAPI to join the board.

POST

https://hq.pixelpaper.io/api/board

curl --location --request POST 'https://hq.pixelpaper.io/api/board'
--header 'Accept: application/json'
--header 'Authorization: Bearer [your-api-token]'

Delete a Board

Just pass the board ID into the URL to delete the board. We'll return a message confirming it has been deleted along with a 200 HTTP status code.

DELETE

https://hq.pixelpaper.io/api/board/{room_id}

curl --location --request DELETE 'https://hq.pixelpaper.io/api/board/{room_id}'
--header 'Accept: application/json'
--header 'Authorization: Bearer [your-api-token]'

List All Boards

You can list all of your boards along with when they were created by hitting this endpoint. You can use the optional query parameters limit and offset to edit the results.

GET

https://hq.pixelpaper.io/api/board?limit=50&offset=5

curl --location --request GET 'https://hq.comet/api/board'
--header 'Accept: application/json'
--header 'Authorization: Bearer [your-api-token]'