---
title: "GET /api/v1/public/help-pages/{agentId}"
method: GET
path: "/api/v1/public/help-pages/{agentId}"
tags: ["agentDeploymentSettings"]
---

# GET /api/v1/public/help-pages/{agentId}

`GET /api/v1/public/help-pages/{agentId}`

## Request

- Base URL: `https://api.clerkchat.co` (the document declares no server; this is the origin it was published from)
- URL: `https://api.clerkchat.co/api/v1/public/help-pages/{agentId}`
- Auth: none required

## Path parameters

- `agentId` string, required

## Response `200`

PublicHelpPage

- PublicHelpPageEncoded
  - `organizationId` string, required
  - `agentId` string, required
  - `displayName` string, required
  - `faviconUrl` string, nullable, required
  - `welcomeMessage` string, nullable, required
  - `title` string, required
  - `subtitle` string, required
  - `inputPlaceholder` string, required
  - `conversationStarters` unknown[], required
    - unknown
  - `poweredBy` boolean, required
  - `chatSoundsEnabled` boolean, required
  - `voiceEnabled` boolean, required
  - `messagingLinks` object[], required
    - `provider` 'telegram' | 'whatsapp', required
    - `url` string, required
  - `theme` 'light' | 'dark' | 'system', required
  - `updatedAt` union, required
    - number
    - 'Infinity' | '-Infinity' | 'NaN'

## Other responses

- `404`: NotFound
- `503`: PersistenceUnavailable

---

[API](https://skmtc.dev/clerkchat/apis/clerk-chat-api.md) · [All operations](https://skmtc.dev/clerkchat/apis/clerk-chat-api/llms.txt) · [OpenAPI document](https://skmtc.dev/clerkchat/apis/clerk-chat-api/revisions/cc318e39e1d0?raw)