v1

latestOpenAPI 3.1.02026-07-242325051.4 MB

Layout

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.

get/v2/layouts/list

Query parameters

eqstring

Get results that equal the given value

Provides filtering based on merchant code.

{
  "eq": "M-1234-4321"
}

eqstring

Filter on the status of an Layout doing an exact match

neqstring

Filter on the status of an Layout excluding an exact match

Filter on the status of an Layout

Response

totalinteger nullable

The total items the collection contains

Example response

{
  "layouts": [
    {
      "code": "LY-1234-4321",
      "status": "APPROVED",
      "name": "My branding",
      "createdAt": "2024-06-04T08:15:00+01:00",
      "createdBy": "A-1234-4321",
      "modifiedAt": "2024-06-04T08:15:00+01:00",
      "modifiedBy": "A-1234-4321",
      "deletedAt": "A-1234-4321",
      "deletedBy": "A-1234-4321"
    }
  ],
  "total": 10
}