---
title: "List button layouts"
method: GET
path: "/button_layouts"
tags: ["Registers"]
---

# List button layouts

`GET /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

## Query parameters

- `after` integer
- `before` integer
- `page_size` integer
- `deleted` boolean

## Response `200`

A versioned collection of ButtonLayout

- ButtonLayoutCollection
  - `data` ButtonLayout[], required
    - `deletedAt` string, date-time, nullable
    - `id` string, required — Autogenerated object identifier.
    - `name` string, required — The name of the button layout.
    - `nodes` ButtonLayoutNode[], required — The nodes that make up the button layout.
      - `attributes` ButtonLayoutNodeAttribute[], required — The attributes associated with this node.
        - `key` string, required — The attribute key.
        - `value` string, required — The attribute value.
      - `id` string, required — Autogenerated object identifier.
      - `parentNodeId` string, uuid, nullable — The ID of the parent node, if applicable.
      - `position` integer, required — The position of the node within its parent.
      - `productId` string, nullable — The product ID associated with this node, if applicable.
    - `version` integer, required — Auto-incrementing object version number.
  - `pagination` PaginationMetadata
    - `page` integer
    - `pageSize` integer
    - `results` integer
  - `version` Version, required — An object containing the highest and lowest version numbers for all items of the returned collection.
    - `max` integer, nullable, required — Highest version number of the payload, or `null` when the result set is empty.
    - `min` integer, nullable, required — Lowest version number of the payload, or `null` when the result set is empty.

---

[API](https://skmtc.net/lightspeedhq/apis/api-2026-07.md) · [All operations](https://skmtc.net/lightspeedhq/apis/api-2026-07/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/lightspeedhq/api-2026-07/revisions/72d4ceb46dbb/schema)