Get Featured Items

GET /api/featured-company

This endpoint retrieves a list of featured items that are displayed on the stats TV displays.

Query Parameters

siteId

ID of the subsite to filter items by. Default is “main”.

Response Body

[
    {
        "name": string,
        "description": string,
        "link": string,
        "type": "logo" | "basic",
        "backgroundImageUuid": string,
        "logoImageUuid": string
    },
    {...}
]

name

Primary text of the item (company name).

description

Secondary long form text for the item.

link

Readable shortened link.

type

Type of card layout.
Logo version contains a logo and a background image.
Basic version contains a background image only.

backgroundImageUuid

UUID of the background image.

https://res.cloudinary.com/drimvo8rp/image/upload/t_featured-company-full/v1674796880/featured-company/{uuid}

Learn how image uploading works

logoImageUuid

UUID of the logo image.
This will only be used if the type is “logo”.

https://res.cloudinary.com/drimvo8rp/image/upload/t_featured-company-logo/v1674796880/featured-company-logo/{uuid}

Learn how image uploading works