List of locations
GET /locations/

Get a list of all locations connected to the account.

Request

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

Response

{
  "statusCode": 200,
  "data": [
    {...},
    {...}
  ]
} 
Returns a list of locations which are wrapped in a data object.
Location details
GET /locations/ id

Get a location by the ID.

Request

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

Response

Returns a location.
List of desks
GET /locations/ id /desks

Get list of desks for specified location.

Request

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

Response

 {
    "statusCode": 200,
    "desks": [
      {
        "name": "1"
      },
      {
        "name": "2"
      },
      {
        "name": "3"
      },
      {
        "name": "4"
      }
    ]
  } 
These fields are wrapped in a desks object:
Response field Type Description
name String Name of a desk
Input fields
GET /locations/ id /input-fields

Get list of input fields for specified location.

Request

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

Response

{
  "statusCode": 200,
  "fields": [
    {"type": "firstName"},
    {"type": "lastName"},
    {"type": "phoneNumber"},
    {"type": "line"},
    {"type": "select", "title": "Gender", "mandatory": true, "options": [
      {"color": "#0052cc", "title": "Male"},
      {"color": "#d4c5f9", "title": "Female"}
    ]}]
}