Limnu API

  2. Home
  4. Limnu API

Limnu API

API Documentation

The Limnu External API creates a way for third-party developers to put a whiteboard in their own app or platform.

Welcome!

The Limnu external API, associated payment models, API authentication keys, and API calls are all in active development.

If there’s anything that would make this system better for you and your products, please let us know by contacting support@limnu.com.

Pricing & Contracts

For business inquiries, including pricing models and options, please visit our API business page. 

API Business Inquiries

Limnu API and API Key notes

All the functions in the Limnu External API require the use of an API Key and an API endpoint issued from Limnu. An API key is issued to a team account. Currently, API keys and endpoints may only be issued by Limnu support manually. 

If for any reason you ever need to retire your current API key and replace it with a new one, this can easily be done by contacting Limnu support.

If you have a valid API key, but your account is not in good standing (that is, you are not paying for your account, or you have no trial credit attached to your account), then all Limnu External API functions with your API key will fail. 

Important Note

Use of this API with your API key can result in additional charges to your account; (for example, if you are on a per-board payment model and your API key is used to call boardCreate). As such, we strongly recommend that you do not make your API key available within your exposed clients, and keep it only on your restricted access servers.

How to request an API key

  • Schedule a meeting with a Limnu team member to learn about features and pricing options

  • Create and pay for a Limnu team - your credit card is charged only after the trial expires

  • Request an API Key and Endpoint from Limnu Support. Tell us what email you used to create your team.

  • Limnu will issue you an API Key and endpoint and provide sample code to get you started

Limnu External API commonalities

All Limnu External API v1 calls adhere to the following rules:

  1. The URL for a function is https://[endpoint provided]/v1/funcName
  2. All functions are all of type POST.
  3. The body of the POST request is a JSON object.
  4. The response to the POST request is a JSON object.
  5. All responses will have a boolean success attribute in the JSON object.
  6. If the call fails, success will be false, and the additional reason attribute will be included in the JSON object for describing the failure.

Articles