---
title: "Layouts:List"
method: GET
path: "/v2/layouts/list"
tags: ["Layout"]
---

# Layouts:List

`GET /v2/layouts/list`

Get a list (without pagination) of all layouts. If you do not supply a merchantCode we return the layouts that are available under your own merchant registration. If you supply a merchantCode you need to have access to that merchant.

## Query parameters

- `merchant` object
  - `eq` string — Get results that equal the given value
- `status` object
  - `eq` string — Filter on the status of an Layout doing an exact match
  - `neq` string — Filter on the status of an Layout excluding an exact match

## Response `200`

OK

- LayoutLayoutsListOutput — A collection of layout lists.
  - `layouts` LayoutLayoutOutput[] — Collection of Layout.LayoutListOutput objects or an empty array
    - `code` string — The LY-code for a layout.
    - `status` 'NOT_CHECKED' | 'APPROVED' | 'DECLINED' | 'RECHECK' — The status of the layout
    - `declineReason` string, nullable — The reason why the layout has been declined
    - `name` string — The name for the layout
    - `merchant` LayoutLayoutOutputMerchant
      - `code` string
      - `status` 'ACTIVE' | 'INACTIVE'
      - `name` string
      - `incorporationCountry` string
    - `createdAt` string, date-time, nullable — The date and time at which this entity was created in ISO-8601 (ATOM) notation
    - `createdBy` string, nullable — The reference to an account or token whom created the entity
    - `modifiedAt` string, date-time, nullable — The date and time at which this entity was modified in ISO-8601 (ATOM) notation.
    - `modifiedBy` string, nullable — The reference to an account or token whom modified this entity
    - `deletedAt` string, date-time, nullable — The date and time at which this entity was deleted in ISO-8601 (ATOM) notation.
    - `deletedBy` string, nullable — The reference to an account or token whom deleted the entity
  - `total` integer, nullable — The total items the collection contains
  - `_links` LinkOutput[], nullable
    - `href` string, nullable — The URI to the linked resource
    - `rel` string, nullable — The name of the linked resource
    - `type` string, nullable — The (http(s)) method needed to approach the linked resource

## Other responses

- `400` — Bad request, see response body for more information
- `401` — Unauthorized. Supplied credentials are invalid
- `403` — Forbidden. Supplied credentials have no rights
- `404` — Resource not found
- `405` — Used HTTP method is not allowed
- `406` — Not acceptable. The supplied content type in the accept parameter in the header is not supported
- `410` — Indicates that this resource is no longer available for use
- `415` — Unsupported media. The supplied content type in the content-type parameter in the header is not supported
- `429` — Rate limit reached.
- `500` — An internal error occurred.
- `503` — The server is currently unable to handle your request

---

[API](https://skmtc.net/pay/apis/pay-transaction-gateway-unit-api.md) · [All operations](https://skmtc.net/pay/apis/pay-transaction-gateway-unit-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/pay/pay-transaction-gateway-unit-api/versions/2bc260c7bdfc/schema)