List public frontend entities
Returns visible public entities for a program or program tree, with optional search, filter, sort, and pagination controls. The controller creates or refreshes a Redis frontend session, marks the session as paginated, applies program setup and settings checks, and returns processed recipient cards plus public display settings. This endpoint is public and uses the optional session id for cart/login state rather than bearer authentication.
Path Parameters
Client id that owns the program and visible entities.
Program id or none. The controller expands program trees and returns 404 when the route value is none.
Optional Redis frontend session id used for pagination, login state, cart messages, and Meta Pixel context. A new session is created when missing or expired.
Query Parameters
Requested page size for paginated program and search responses. Invalid or non-positive values default to 20.
x >= 1Requested page number for paginated responses. Invalid or non-positive values default to 1.
x >= 1Search term used by Scout/Meilisearch and title-field fallback matching.
Legacy interaction mode. filter applies field filters from key and name; sort applies ordering from key and order.
filter, sort Field key or array of field keys used for filter or sort operations.
Filter value or array of values aligned with key when eventKey=filter.
Sort order used when eventKey=sort.
asc, desc Optional positive program id selected within the requested program tree.
x >= 1Public sort field. Supply together with sortOrder.
Sort direction; must be supplied together with sortKey.
asc, desc Map of public field keys to filter values. Values must be scalar.
Structured public filter groups, including age filters. Must be a list.
Whether pagination computes a total row count. Defaults to true.
Returns program display metadata without recipient cards when true.
Response
Public entity listing payload.