Skip to main content
GET
List public frontend entities

Path Parameters

client_id
integer
required

Client id that owns the program and visible entities.

program_id
string
required

Program id or none. The controller expands program trees and returns 404 when the route value is none.

session_id
string
required

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

pageSize
integer

Requested page size for paginated program and search responses. Invalid or non-positive values default to 20.

Required range: x >= 1
pageIndex
integer

Requested page number for paginated responses. Invalid or non-positive values default to 1.

Required range: x >= 1

Search term used by Scout/Meilisearch and title-field fallback matching.

eventKey
enum<string>

Legacy interaction mode. filter applies field filters from key and name; sort applies ordering from key and order.

Available options:
filter,
sort
key
string

Field key or array of field keys used for filter or sort operations.

name
string

Filter value or array of values aligned with key when eventKey=filter.

order
enum<string>

Sort order used when eventKey=sort.

Available options:
asc,
desc
selectedProgramId
integer

Optional positive program id selected within the requested program tree.

Required range: x >= 1
sortKey
string

Public sort field. Supply together with sortOrder.

sortOrder
enum<string>

Sort direction; must be supplied together with sortKey.

Available options:
asc,
desc
fieldFilters
object

Map of public field keys to filter values. Values must be scalar.

filterGroups
object[]

Structured public filter groups, including age filters. Must be a list.

includeTotal
boolean
default:true

Whether pagination computes a total row count. Defaults to true.

summary
boolean
default:false

Returns program display metadata without recipient cards when true.

Response

Public entity listing payload.

data
object