Skip to main content
Version: 202601

List addable cards

GET 

/openapi/2026-01/themes/cards

List all addable cards under the current theme across sources (theme, pb, custom, extension, public, gen), de-duplicated, ordered by source, and paginated.

Request

Query Parameters

    theme_id string

    Theme ID. Optional; only used by the theme source. Empty -> the theme source returns empty

    source string[]

    Data source filter. Multi-value (repeat the param source=pb&source=public, or comma-join source=pb,public); empty aggregates every source:

    • theme: cards bundled with the theme
    • pb: page-builder cards from public templates
    • custom: page-builder cards from the merchant's custom card templates
    • extension: app extension cards
    • public: public cards
    • gen: AI cards
    category string

    Primary category filter. Only applies to the pb source

    second_category string

    Secondary category filter. Only applies to the pb source

    limit int32

    Page size, defaults to 10, range 1-100

    page int32

    Page number

    template string

    Template filter. Template name (index, product, collection, cart, page, search, or a custom template name)

Responses

OK

Schema
    codestring

    error code

    messagestring

    error message

    data object
    items object[]

    Cards on this page

  • Array [
  • idstring

    Global unique ID, shaped by source: pb = global-<template_id>; custom = custom-<template_id>; theme = the section type; extension / public = the full block type shoplazza://apps/<app_id>/blocks/<location>/<extension_id>

    sourcestring

    Source:

    • theme: cards bundled with the theme
    • pb: page-builder cards from public templates
    • custom: page-builder cards from the merchant's custom card templates
    • extension: app extension cards
    • public: public cards
    • gen: AI cards
    nameGoogleProtobufValue

    Name. Usually a multi-language object {"zh-CN": "...", "en-US": "..."}, but may be a plain string depending on source

    categorystring

    Primary category (pb only)

    second_categorystring

    Secondary category (pb only)

    descriptionstring

    Description (currently empty for all sources)

    preview_imagestring

    Preview image URL (pb only)

    updated_atstring

    Update time RFC3339 (pb only)

    templatesstring[]

    Templates the card can be added to. Non-empty = only these template pages; empty = all pages

    limitint32

    Max instances of this card on a single page. 0 = unlimited

  • ]
  • totalint32

    Total number of cards across the selected sources

    pageint32

    Current page number

    limitint32

    Page size

    has_moreboolean

    Whether more pages exist