API Reference

Qminder API documentation

Qminder provides RESTful API for integrating your mobile application or website with Qminder.
In order to use Qminder API you need API keys which are available only with paid plan.

Get API key

  1. Log in to Qminder Dashboard.
  2. Enable API
    Step 1
  3. Get API keys
    Step 2

Making a request

All endpoints are only accessible via https and are located at api.qminderapp.com

Base url for all endpoints is https://api.qminderapp.com/v1/

With every request you need to send an API key.

Sending API call as POST parameter:

curl https://api.qminderapp.com/v1/locations/
-H "X-Qminder-REST-API-Key: KEY"

Sending API call as URL parameter:

curl https://api.qminderapp.com/v1/locations/?rest-api-key=KEY

Sending key as POST parameter is preferred over key in URL.
All examples specify key as a POST parameter.

Keys come in two flavors: publishable and secret.
In most cases it is safe to distribute publishable key with iOS or Android applications.
Secret key must be used only in your server side code.

Response

When response is successful, HTTP status code is 200.

In case of an error, status code will be 4XX or 5XX.

Response body is in JSON format. Every response will have HTTP status code reflected in the "statusCode" field.

{
  "statusCode": 200,
  "id": 1827,
  "name": "Registration",
  "peopleWaiting": 3,
  "estimatedTimeOfService": "2013-07-03T16:27Z"
}

Error responses will include "message" field and optionally "developerMessage" for debugging the issue.

{
  "statusCode": 401,
  "message": "Please authenticate",
  "developerMessage": "Set X-Qminder-REST-API-Key HTTP header with API publishable key"
}

Limits

Rate limits are applied inclusive of all API calls made over the 1-hour sliding window, regardless of the particular endpoint.

Rate Limit: 5,000 / hour per account

Information regarding the rate limits is included in the HTTP header on the response to each of your calls:
X-Ratelimit-Remaining: the remaining number of calls available within the 1-hour window