---
title: "Get KC Bots"
method: GET
path: "/v1/kcbot"
tags: ["KCbot"]
---

# Get KC Bots

`GET /v1/kcbot`

## Request

- Base URL: `https://app.aptrinsic.com`
- URL: `https://app.aptrinsic.com/v1/kcbot`
- Auth: none declared
- TypeScript: <https://skmtc.dev/gainsight/apis/gainsight-px-rest-api/docs/v1/kcbot/get.ts> (a function with typed inputs; its response is checked against the schema)

Fetch metadata for KC Bots from your PX Subscription. The API provides you with the summary of basic information of each KC Bot that makes it easy to work with specific data.

Examples: 

| URI   | Results  |
| ----- | -------- |
| GET /v1/kcbot?pageSize=100 | Get first 100 KcBots. |
| GET /v1/kcbot?pageSize=100&pageNumber=1 | Get next 100 KcBots. |
| GET /v1/kcbot?productId=1234LPSWUBFW | Get KcBots of product 1234LPSWUBFW. |

<b>Important:</b> The default pageSize on list calls is 200. The pageSize can be changed by adding a pageSize parameter to the URL (i.e. /v1/kcbot?pageSize=100) with a max pageSize=500. 

To fetch a particular page, use the pageNumber parameter (zero based)

## Query parameters

- `pageNumber` integer
- `pageSize` integer
- `productId` string

## Response `200`

Success

- KnowledgeCenterExternalViewPage
  - `kcList` KnowledgeCenterExternalView[]: Array of KC View
    - `createdBy` UserView
      - `id` string
      - `name` string
    - `createdDate` integer
    - `defaultLanguage` string
    - `description` string
    - `environments` string[]
    - `id` string
    - `languages` LocalizationStatus[]
      - `languageCode` string
      - `translated` boolean
    - `modifiedBy` UserView
      - `id` string
      - `name` string
    - `modifiedDate` integer
    - `name` string
    - `priority` integer
    - `productId` string
    - `productName` string
    - `status` string
  - `pageNumber` integer: Page number
  - `isLastPage` boolean: True if no more records available on next page

## Other responses

- `400`: Bad request
- `401`: Unauthorized or bad API Key
- `429`: Rate limit exceeded

---

[API](https://skmtc.dev/gainsight/apis/gainsight-px-rest-api.md) - [All operations](https://skmtc.dev/gainsight/apis/gainsight-px-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/gainsight/apis/gainsight-px-rest-api/revisions/e7b197b373d8?raw)
