Workspaces (v5)

Get Workspace By ID

Get a workspace by ID (users are not included, use /workspaces/:id/users endpoint)

get/v5/workspaces/{id}

Request

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

Path parameters

idstring required

Response

idstring required

Workspace ID

namestring required

Workspace name

vanity_namestring nullable

Workspace vanity name

descriptionstring nullable

Workspace description

image_urlstring nullable

Workspace image URL

type'standard' | 'webcontact' | 'personallink'
created_atstring date-time required

Workspace creation date

last_updated_atstring date-time required

Last update date

owner_idstring nullable

Workspace owner ID

creator_idstring nullable

Workspace creator ID

plan_type'standard' | 'business-premium' | 'team-premium' | 'personal-premium' | 'free'
background_colorstring nullable

Background color

watermark_image_urlstring nullable

Watermark image URL

conversation_defaultboolean nullable

Whether this workspace is the default for conversations

invitation_mode'anyone' | 'admin-only' | 'any-member'
sso_email_domainstring nullable

SSO email domain

scim_providerstring nullable

SCIM provider

scim_connection_namestring nullable

SCIM connection name

is_retention_enabledboolean nullable

Whether retention is enabled

retention_daysnumber nullable

Retention days

who_can_change_conversation_retentionRole[] nullable

Roles that can change conversation retention

who_can_mark_messages_as_preservedRole[] nullable

Roles that can mark messages as preserved

retention_days_async_meetingnumber nullable

Retention days for async meetings

domain_referral_mode'do-not-inform' | 'automatic' | 'request' | 'share-instructions'
domain_referral_messagestring nullable

Domain referral message

domain_referral_titlestring nullable

Domain referral title

domainsstring[] nullable

Associated domains

Changes

No recorded changes to this operation across all 1 revision of this API.