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

GET /o/op/data/account-profiles
OAuth2

Returns a list of active account profiles for a specific business location. The account profile code can be used to retrieve a specific price list when loading a menu.

Query parameters

Responses

  • • 200 application/json

    Account profiles

    Hide response attributes Show response attributes object
    • businessLocationId integer(int64)

      The unique identifier of the business location.

    • accountProfileList array[object]
      Hide accountProfileList attributes Show accountProfileList attributes object
      • id integer(int64)

        The unique identifier for the account profile

      • code string

        A short code representing the account profile

      • name string

        The system display name for the account profile

      • deliveryMode string

        Specifies the delivery mode for the account profile

        Values are NONE, TAKE_AWAY, or DELIVERY.
GET /o/op/data/account-profiles 
curl \
 -X GET https://api.trial.lsk.lightspeed.app/o/op/data/account-profiles?businessLocationId=45454565682155 \
 -H "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
{
  "businessLocationId": 45454565682155,
  "accountProfileList": [
    {
      "id": 12454575601144,
      "code": "takeaway",
      "name": "Takeaway",
      "deliveryMode": "TAKE_AWAY"
    }
  ]
}