Auto-Generated Documentation: This endpoint list is automatically generated from the API controllers. All routes, validation rules, and requirements are discovered via reflection.

Channel

POST /v1/channel/content Auth Required

Fetch channel content by GUID

Parameters & Validation
Parameter Type Required Validation
guid string Required min: 8, max: 64
screenMode string Optional pattern: /^(land|port|land-180|port-180)$/

Channels

GET /v1/channels Auth Required

List all active channels

Parameters & Validation
Parameter Type Required Validation
page integer Optional min: 1
limit integer Optional min: 1, max: 100
search string Optional min: 1, max: 255

Health

GET /v1/health Public

Health check endpoint — no auth required.

V1

GET /v1/v1/adverts/audio Auth Required

List all audio adverts

Parameters & Validation
Parameter Type Required Validation
page integer Optional min: 1
limit integer Optional min: 1, max: 100
search string Optional min: 1, max: 255
GET /v1/v1/adverts/images Auth Required

List all image adverts

Parameters & Validation
Parameter Type Required Validation
page integer Optional min: 1
limit integer Optional min: 1, max: 100
search string Optional min: 1, max: 255
GET /v1/v1/adverts/menus Auth Required

List all menus

Parameters & Validation
Parameter Type Required Validation
page integer Optional min: 1
limit integer Optional min: 1, max: 100
search string Optional min: 1, max: 255
active_only string Optional pattern: /^(0|1)$/
GET /v1/v1/adverts/videos Auth Required

List all video adverts

Parameters & Validation
Parameter Type Required Validation
page integer Optional min: 1
limit integer Optional min: 1, max: 100
search string Optional min: 1, max: 255
GET /v1/v1/client Auth Required

Get client information for the authenticated API key's client

Common Request Headers

Header Required Description
Authorization For protected endpoints Bearer token with your API key
Content-Type For POST/PUT/PATCH Should be application/json
Accept Optional Set to application/json