Workspaces

Get Workspace by ID

get/v3/workspaces/{workspaceguid}

Request

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

Path parameters

workspaceguidstring required

Response

_idstring required
vanity_namestring nullable
namestring required
descriptionstring nullable
image_urlstring nullable
type'standard' | 'webcontact' | 'personallink'
created_atstring date-time required
last_updated_atstring date-time required
plan_type'standard' | 'business-premium' | 'team-premium' | 'personal-premium' | 'free'
settingsobject required
background_colorstring nullable required
watermark_image_urlstring nullable required
conversation_defaultboolean required
invitation_mode'anyone' | 'admin-only' | 'any-member' required
sso_email_domainstring nullable required
scim_providerstring nullable required
scim_connection_namestring nullable required
is_retention_enabledboolean nullable
retention_daysnumber nullable
who_can_change_conversation_retentionRole[] nullable
who_can_mark_messages_as_preservedRole[] nullable
retention_days_async_meetingnumber nullable
domain_referral_mode'do-not-inform' | 'automatic' | 'request' | 'share-instructions' required
domain_referral_messagestring nullable
domain_referral_titlestring nullable
domainsstring[] required

Changes

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