Lightspeed Restaurant K Series API
1.0.0

Lightspeed Restaurant offers a REST API in order to communicate with the data in the system. These APIs are built using the RESTful standards and adhere to the basic verb interactions as defined by the REST standard.

These services are in continuous development and subject to change. Find our versioning policy here.

This is the documentation for version 1.0.0 of the API. Last update on May 1, 2024.

Base URL 
https://api.trial.lsk.lightspeed.app

Get Businesses

GET /f/data/businesses
OAuth2

Returns all businesses the token has access to.

Query parameters

  • page integer(int32)

    Starting page of results, when paginating

    Default value is 0.

  • size integer(int32)

    Number of results to return, when paginating

    Default value is 1000.

Responses

  • • 200 application/json

    Businesses returned

    Hide response attributes Show response attributes object
    • _embedded object
      Hide _embedded attribute Show _embedded attribute
    • _links object
      Hide _links attribute Show _links attribute
      • self object
        Hide self attribute Show self attribute
GET /f/data/businesses 
curl \
 -X GET https://api.trial.lsk.lightspeed.app/f/data/businesses \
 -H "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
{
  "_embedded": {
    "businessList": [
      {
        "businessName": "My Business",
        "businessId": 1234,
        "currencyCode": "GBP",
        "businessLocations": [
          {
            "blName": "My Business Location 1",
            "blID": 1234567890,
            "country": "GB",
            "timezone": "Europe/London"
          }
        ]
      }
    ]
  },
  "_links": {
    "self": {
      "href": "https:///api.ikentoo.com/data/businesses"
    }
  }
}