---
title: "Read the help centre"
method: GET
path: "/v1/projects/{projectId}/messenger/help-centre"
tags: ["messenger"]
---

# Read the help centre

`GET /v1/projects/{projectId}/messenger/help-centre`

## Request

- Base URL: `https://api.prodantix.com`
- URL: `https://api.prodantix.com/v1/projects/{projectId}/messenger/help-centre`
- Auth: HTTP bearer

The company's Clepit help site as the messenger reads it (its address, how many articles and in which languages, when they were last read and why the last read failed) and whether this project's visitors can search its articles.

## Path parameters

- `projectId` string, required

## Response `200`

The help centre and the project's article search

- object
  - `site` HelpCentreSiteBody
    - `url` string, required
    - `articles` integer, required
    - `languages` string[], required
    - `lastReadAt` string, nullable
    - `readError` string, nullable
    - `capped` boolean, required
  - `search` ArticleSearchBody, required
    - `on` boolean, required
    - `placement` 'tab' | 'first_view' | 'while_typing', required

## Other responses

- `403`: The caller may not do this
- `404`: The project is not there

---

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