Help Content Registry

List all registered help content entries (supports ?screen_id= and ?field_id= filters)

{
  "data": [
    {
      "help_id": "help-001",
      "screen_id": "screen-02",
      "field_id": "date_of_birth",
      "text": "Enter your date of birth as DD/MM/YYYY, e.g. 15/03/1985.",
      "locale": "en-IE",
      "updated_at": "2026-02-01T12:00:00Z"
    },
    {
      "help_id": "help-002",
      "screen_id": "screen-03",
      "field_id": "pps_number",
      "text": "Your PPS number is on your Public Services Card or a letter from the Department of Social Protection.",
      "locale": "en-IE",
      "updated_at": "2026-02-01T12:00:00Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 31
  }
}

Get a specific help content entry by ID

{
  "help_id": "help-002",
  "screen_id": "screen-03",
  "field_id": "pps_number",
  "text": "Your PPS number is on your Public Services Card or a letter from the Department of Social Protection.",
  "locale": "en-IE",
  "created_at": "2026-01-20T09:00:00Z",
  "updated_at": "2026-02-01T12:00:00Z"
}

Register a new help content entry for a screen/field pair

{
  "screen_id": "screen-05",
  "field_id": "eircode",
  "text": "Your Eircode is a 7-character code used to identify your address. You can find it at eircode.ie by entering your address.",
  "locale": "en-IE"
}

{
  "help_id": "help-032",
  "screen_id": "screen-05",
  "field_id": "eircode",
  "locale": "en-IE",
  "created_at": "2026-03-26T11:50:00Z"
}

Update an existing help content entry

{
  "text": "Your PPS number is a 7-character code starting with numbers. Find it on your Public Services Card, payslip, or tax documents."
}

{
  "help_id": "help-002",
  "screen_id": "screen-03",
  "field_id": "pps_number",
  "text": "Your PPS number is a 7-character code starting with numbers. Find it on your Public Services Card, payslip, or tax documents.",
  "updated_at": "2026-03-26T11:55:00Z"
}

Delete a help content entry

{
  "deleted": true,
  "help_id": "help-032"
}

Look up help text for a specific screen and field (returns 404 if not registered)

{
  "screen_id": "screen-03",
  "field_id": "pps_number",
  "text": "Your PPS number is a 7-character code. Find it on your Public Services Card or tax documents.",
  "locale": "en-IE",
  "has_help_text": true
}

Bulk-load help content from an asset file for a given locale

{
  "asset_path": "assets/help/en-IE.json",
  "locale": "en-IE"
}

{
  "locale": "en-IE",
  "entries_loaded": 31,
  "entries_created": 29,
  "entries_updated": 2,
  "loaded_at": "2026-03-26T12:00:00Z"
}

{
  "contract_summary": {
    "total_contracts": 410,
    "total_endpoints": 2416,
    "api_styles_used": [
      "rest"
    ]
  },
  "generated_at": "2026-03-26T06:55:53.316Z"
}