Qminder API documentation

Qminder provides RESTful API for integrating your existing systems with Qminder.
In order to use Qminder API you need API key.

Get API key

In the Qminder Dashboard navigate to Account Setup to create the key.

Create API Key

Making a request

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

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

With every request you need to send an API key.

Sending API call as header field:

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

Sending API call as URL parameter:

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

Sending key as header field is preferred over key in URL.
All examples specify key as a header field.

Response

When response is successful, HTTP status code is between 200 and 299.

In case of an error, status code will be between 400 and 599.

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

{
  "statusCode": 200,
  "id": "42367593",
  "status": "NEW",
  "source": "MANUAL",
  "line": 102321,
  "firstName": "Mari",
  "lastName": "Müür",
  "created": {
    "date": "2018-12-31T13:53:19.243Z"
  }
}

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 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