API Reference

List button layouts

get
https://{domain_prefix}.retail.lightspeed.app/api/2026-07/button_layouts

Returns a versioned collection of button layouts for the authenticated retailer.
Button layouts define the arrangement of quick key buttons on a register.

🔒 Requires: registers:read scope

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
int64

The lower limit for the version numbers to be included in the response.

int64

The upper limit for the version numbers to be included in the response.

integer

The maximum number of items to be returned in the response.

boolean

Indicates whether deleted items should be included in the response.

Response

Updated 18 days ago

Did this page help you?
Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 18 days ago

Did this page help you?