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

# Retrieve a list of platform examples

`GET /platform/example/list`

## Request

- Base URL: `https://api.chatbotkit.com/api/v1`
- URL: `https://api.chatbotkit.com/api/v1/platform/example/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 examples was retrieved successfully

- object
  - `items` object[], required
    - `name` string, required: The associated name
    - `description` string, required: 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
    - `type` 'blueprint' | 'project' | 'widget' | 'slack' | 'discord' | 'whatsapp' | 'messenger' | 'telegram' | 'twilio' | 'email' | 'trigger', required: The type of the example
    - `tags` string[]: Tags associated with the example
    - `link` string, required: The URL to the official example page
  - `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)