Get Businesses

GET /f/data/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.

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
  
  Additional properties are allowed.
  
  Hide _embedded attribute Show _embedded attribute object
  
  businessList array[object]
  
  Hide businessList attributes Show businessList attributes object
  
  businessName string
  
  The name of the business.
  
  businessId number
  
  The unique identifier for the business.
  
  currencyCode string
  
  The ISO 4217 currency code
  
  businessLocations array[object]
  
  Hide businessLocations attributes Show businessLocations attributes object
  
  blName string
  
  The name of the business location.
  
  blID number
  
  The unique identifier for the business location.
  
  country string
  
  The ISO 3166 country code.
  
  timezone string
  
  The time zone in ICANN format.
- _links object
  
  Additional properties are allowed.
  
  Hide _links attribute Show _links attribute object
  
  self object
  
  Additional properties are allowed.
  
  Hide self attribute Show self attribute object
  
  href string

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