Skip to content
UltimateTeam.ai Docs

Get contextual help for a page

GET
/api/v1/help/content

UX-02: Return vertical-aware help content with 3-step fallback (vertical -> generic -> placeholder).

Authorizations

Parameters

Query Parameters

page_key
required

Dashboard page identifier

string

Dashboard page identifier

locale

Content locale

string
default: en

Content locale

Responses

200

Successful Response

Response schema for a single help content entry.

Returned by GET /api/v1/help/content.

object
id
Any of:
string format: uuid
last_generated_at
Any of:
string format: date-time
locale

Content locale (BCP-47).

string
default: en
markdown
required

Help content body in Markdown.

string
page_key
required

Dashboard page identifier (e.g. ‘dashboard.hq’).

string
version
Any of:
string
vertical_slug
required

Vertical slug or ‘_generic’.

string

422

Validation Error

object
detail
Array<object>
object
ctx
object
input
loc
required
Array
msg
required
string
type
required
string