---
title: "List the chat platforms a workspace can connect"
method: GET
path: "/v1/chat-platforms"
tags: ["chat-platforms"]
---

# List the chat platforms a workspace can connect

`GET /v1/chat-platforms`

## Request

- Base URL: `https://api.patricia.app` (the document declares no server; this is the origin it was published from)
- URL: `https://api.patricia.app/v1/chat-platforms`
- Auth: none declared

Every chat platform a workspace can connect, with the name the dashboard shows and the capabilities it reads. Public: the answer holds no workspace data.

## Response `200`

Successful Response

- ChatPlatformsResponse: Every chat platform a workspace can connect, in the order the dashboard lists them.
  - `platforms` ChatPlatformEntry[], required
    - `code` string, required: The platform code stored on actors, conversations and installations.
    - `chat_platform` 'slack' | 'microsoft_teams', required: The value the onboarding endpoints use for this platform, in fields such as `chat_platform`.
    - `display_name` string, required: The customer-facing name, e.g. "Microsoft Teams".
    - `connect_releases_starter_credits` boolean, required: Whether installing this platform releases a first workspace's held starter credits.

---

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