---
title: "Retrieve a list of platform secrets"
method: GET
path: "/platform/secret/list"
tags: ["Platform"]
---

# Retrieve a list of platform secrets

`GET /platform/secret/list`

## Request

- Base URL: `https://api.chatbotkit.com/api/v1`
- URL: `https://api.chatbotkit.com/api/v1/platform/secret/list`
- Auth: HTTP bearer

## Query parameters

- `cursor` string: The cursor to use for pagination
- `order` 'asc' | 'desc': The order of the paginated items
- `take` integer: The number of items to retrieve
- `meta` object: Key-value pairs to filter the items by metadata

## Response `200`

The list of secrets was retrieved successfully

- object
  - `items` object[], required
    - `name` string: The associated name
    - `description` string: The associated description
    - `meta` Meta: Meta data information
    - `id` string, required: The instance ID
    - `createdAt` number, required: The timestamp (ms) when the instance was created
    - `updatedAt` number, required: The timestamp (ms) when the instance was updated
    - `template` string: The original template identifier for the secret
    - `type` 'plain' | 'basic' | 'bearer' | 'jwt' | 'oauth' | 'template' | 'reference', required: The type of the secret
    - `kind` 'shared' | 'personal': The kind of the secret
    - `config` object
    - `icon` string
    - `tags` string[]
    - `setup` string
    - `commentary` string
  - `cursor` string, required: Cursor for fetching the next page

## Other responses

- `default`: An error response

---

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