1. Home
  2. Limnu API
  3. Function: boardList

Function: boardList

Overview

boardList lists all boards owned by your account . If you have used boardCreate to delete some of your boards, those boards will not be returned by boardList.

Parameters

Input parameters:

  • apiKey: Private API key issued by Limnu to developers.

In addition to the common output values, a successful boardCreate response will also include:

  • boardList: Contains a list of boards owned by the account associated with the API Key.

Response attribute details: boardList

boardList contains the list of boards owned by this account which have not been deleted (eg: with a function like boardDelete).

The list is structured like this:

[ { "boardId": "B_B7LyhbF2QGaCV4",

"createdAt": 1464553780,

"boardName": "My first API-created Limnu board!" },

… with more board objects as needed.

]

All boards owned by the account associated with the API Key will be listed. If a board has been deleted (eg: through a function like boardDelete), the board will not be listed. You can think of this function as listing only the boards you are currently being charged for.

The boardId field matches the boardId returned from the boardCreate function.

The createdAt field is the time (in UTC seconds) when the board was created.

The boardName field contains the name given to the board when it was created.

Example data

Example of correct JSON input:

{

"apiKey": "K_isR4E6qcQamY0NxFuKa9aw7k5hssRBQXuqpStgR1qU1A"

}

Example of JSON output from a successful call:

{

"success": true,

"boardList": [

{ "boardId": "B_B7LyhbF2QGaCV4",

"createdAt": 1464553780,

"boardName": "My first API-created Limnu board!" },

{ "boardId": "B_FGe9olQ9Sa2c8r",

"createdAt": 1466886636,

"boardName": "Another board I made" }

]

}

Example of JSON output from a failed call:

{

"success": false,

"reason": "Bad API key"

}

Command Line Testing

Here’s an example of how to test boardList from the command line:

curl \

https://api.limnu.com/v1/boardList \

--request POST \

--header "Content-Type: application/json" \

--data @boardList.json

 

The contents of the file named boardList.json are:

{

"apiKey": "K_isR4E6qcQamY0NxFuKa9aw7k5hssRBQXuqpStgR1qU1A"

}