---
title: "Get suggested workspaces"
method: GET
path: "/v3/workspace/suggested"
tags: ["Workspaces"]
---

# Get suggested workspaces

`GET /v3/workspace/suggested`

## Request

- Base URL: `https://api.carbonvoice.app`
- URL: `https://api.carbonvoice.app/v3/workspace/suggested`
- Auth: one of:
  - API key in header `pxtoken`
  - OAuth 2 (implicit, authorization URL `https://api.carbonvoice.app/oauth/authorize`)

## Response `200`

- SuggestedWorkspacesResponse
  - `joinableWorkspaces` JoinableWorkspace[], required
    - `id` string, required
    - `name` string, required
    - `domains` string[], required
    - `watermark_url` string
    - `background_color` string
    - `image_url` string
    - `users` number, required
    - `channels` number, required
    - `domain_referral_mode` 'do-not-inform' | 'automatic' | 'request' | 'share-instructions', required
    - `domain_referral_message` string
  - `creatableWorkspaces` CreatableWorkspace[], required
    - `domain` string, required
    - `numberOfUsers` number, required
    - `existingWorkspaces` string[], required

---

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