Skip to content

Layout

Get layout cards

Retrieve a list of layout cards configured for the client. Layout cards are used to display informational or navigational content in the client UI, such as headings, descriptive text, icons and links.

This endpoint is available to both authenticated and unauthenticated users.

Request

Example

GET /v2/layout/card

Parameters

(none)

Response

Example

[
  {
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "description": "Service information",
    "text": "Welcome to Mina sidor. Here you can manage your tenancy.",
    "order": 1,
    "heading": "Welcome",
    "size": 1,
    "iconSvg": "<svg>...</svg>",
    "url": [
      {
        "description": "Read more",
        "url": "https://example.com/more-info"
      }
    ]
  }
]

Response items

Name Description
id Unique identifier (GUID) of the card.
description Internal designation/label for the card.
text Body text content of the card.
order Display order of the card relative to other cards. Lower values appear first.
heading Heading/title text of the card.
size Size variant of the card. Controls how much space the card occupies in the layout. 0 = Banner, 1 = Small, 2 = Medium, 3 = Large, 4 = XLarge
iconSvg SVG markup for an optional icon to display on the card.
url List of URL objects associated with the card. See URL object below.

.url

Name Description
description Link text for the URL.
url The URL the link points to.