---
title: "Get Workspaces"
method: GET
path: "/v5/workspaces"
tags: ["Workspaces (v5)"]
---

# Get Workspaces

`GET /v5/workspaces`

## Request

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

List all workspaces for the logged-in user with pagination

## Query parameters

- `direction` 'older' | 'newer'
- `limit` number
- `date` string
- `starting_after` string
- `ending_before` string
- `roles` Role[]
- `types` WorkspaceType[]
- `include_total` boolean

## Response `200`

- GetWorkspacesResponseV5
  - `results` WorkspaceV5[], required: List of workspaces
    - `id` string, required: Workspace ID
    - `name` string, required: Workspace name
    - `vanity_name` string, nullable: Workspace vanity name
    - `description` string, nullable: Workspace description
    - `image_url` string, nullable: Workspace image URL
    - `type` 'standard' | 'webcontact' | 'personallink'
    - `created_at` string, date-time, required: Workspace creation date
    - `last_updated_at` string, date-time, required: Last update date
    - `owner_id` string, nullable: Workspace owner ID
    - `creator_id` string, nullable: Workspace creator ID
    - `plan_type` 'standard' | 'business-premium' | 'team-premium' | 'personal-premium' | 'free'
    - `phones` WorkspacePhoneV5[], nullable: Workspace phone numbers (only included in single workspace response)
      - `id` string, required: Phone ID
      - `number` string, required: Phone number
      - `type` 'voicemail', required
      - `label` string, required: Phone label
      - `destination_workspace_id` string, nullable: Destination workspace ID
      - `parent_phone` string, nullable: Parent phone number
      - `message_url` string, nullable: Message URL
      - `phone_sid` string, nullable: Phone SID
    - `background_color` string, nullable: Background color
    - `watermark_image_url` string, nullable: Watermark image URL
    - `conversation_default` boolean, nullable: Whether this workspace is the default for conversations
    - `invitation_mode` 'anyone' | 'admin-only' | 'any-member'
    - `sso_email_domain` string, nullable: SSO email domain
    - `scim_provider` string, nullable: SCIM provider
    - `scim_connection_name` string, nullable: SCIM connection name
    - `is_retention_enabled` boolean, nullable: Whether retention is enabled
    - `retention_days` number, nullable: Retention days
    - `who_can_change_conversation_retention` Role[], nullable: Roles that can change conversation retention
    - `who_can_mark_messages_as_preserved` Role[], nullable: Roles that can mark messages as preserved
    - `retention_days_async_meeting` number, nullable: Retention days for async meetings
    - `domain_referral_mode` 'do-not-inform' | 'automatic' | 'request' | 'share-instructions'
    - `domain_referral_message` string, nullable: Domain referral message
    - `domain_referral_title` string, nullable: Domain referral title
    - `domains` string[], nullable: Associated domains
  - `next_cursor` string, nullable: Cursor to fetch the next page
  - `has_more` boolean, required: Whether there are more items to fetch
  - `total` number, nullable: Total number of workspaces (filtered by the query). Only included when include_total=true is provided in the query.
  - `filters` WorkspacesFiltersV5, required
    - `direction` 'older' | 'newer', required
    - `limit` number, required: Number of items per page
    - `date` string, nullable: Anchor timestamp to start from
    - `starting_after` string, nullable: Cursor to fetch the next page
    - `ending_before` string, nullable: Cursor to fetch the previous page
    - `roles` Role[], nullable: List of roles filter
    - `types` WorkspaceType[], nullable: List of workspace types filter

## Other responses

- `403`

---

[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)