Get Business Locations

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL

https://api-docs.lsk.lightspeed.app/mcp

Standard setup for AI tools providing an mcp.json file

mcp.json
{
  "Lightspeed Restaurant K-Series MCP server": {
    "url": "https://api-docs.lsk.lightspeed.app/mcp"
  }
}

Close
GET /reservation/api/1/user/platform/{platform-code}/business-locations

Retrieve all the business locations accessible for a User

Path parameters

  • platform-code string Required

    The unique code assigned to the reservation platform.

    Maximum length is 11. Format should match the following pattern: [a-zA-Z0-9_-]+.

Query parameters

  • page integer(int32)

    The page number, when paginating

    Default value is 0.

  • size integer(int32)

    The items per page, when paginating

    Default value is 1000.

Responses

  • 200 application/json

    A list of business locations

    Hide response attributes Show response attributes object
    • businessLocationId string Required

      The unique identifier of the business location.

    • city string

      The business location's city.

    • country string

      The business location's country.

    • name string

      The business location's name.

    • state string

      The business location's state.

    • street1 string

      The first line of the business location's street address.

    • street2 string

      The second line of the business location's street address.

    • zip string

      The business location's postal code.

  • 400

    Non relevant request

  • 403

    Access token not relevant for the businessLocation, use authorization-code

  • 404

    No business locations found

GET /reservation/api/1/user/platform/{platform-code}/business-locations
curl \
 --request GET 'https://api.trial.lsk.lightspeed.app/reservation/api/1/user/platform/MyPlatform/business-locations' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200)
[{"businessLocationId" => "123456789", "city" => "Genève", "country" => "CH", "name" => "Le Gâteau", "state" => "Canton de Genève", "street1" => "Rue de la Servette 10", "street2" => "Suite 2", "zip" => "101201"}]