LIlightspeed
Financial

Get Businesses

Returns all businesses the token has access to. Pagination is supported by providing the page and size query parameters. The maximum number of business locations per business returned is 500.

get/f/data/businesses

Request

  • Base URL
    https://api.trial.lsk.lightspeed.app
  • URL
    https://api.trial.lsk.lightspeed.app/f/data/businesses
  • Auth
    OAuth 2
    Authorization code: https://auth.lsk-prod.app/realms/k-series/protocol/openid-connect/auth
    Token URL: https://auth.lsk-prod.app/realms/k-series/protocol/openid-connect/token scopes: financial-api

Query parameters

pageinteger

Starting page of results, when paginating.

sizeinteger

Number of results to return, when paginating.

Response

Businesses returned

Example response

{
  "_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"
    }
  }
}

Changes

No operation changes recorded.