Pricing & Contracts

Limnu API and API Key notes

All the functions in the Limnu External API require the use of an API Key issued from Limnu. An API key may be issued to either a team or a user account. Currently, API keys 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.

Limnu External API commonalities

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

The URL for a function is https://api.limnu.com/v1/funcName

All functions are all of type POST.

The body of the POST request is a JSON object.

The response to the POST request is a JSON object.

All responses will have a boolean success attribute in the JSON object.

If the call fails, success will be false, and the additional reason attribute will be included in the JSON object for describing the failure.