---
title: "GET /settings"
method: GET
path: "/settings"
tags: ["Settings"]
---

# GET /settings

`GET /settings`

## Request

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

## Response `200`

- Settings
  - `OrganizationSettings` LeveledSettings, required
    - `addMembers` Setting, required
      - `id` string, required
      - `name` string, required
      - `applied_to` 'organization' | 'workspace' | 'channel' | 'message', required
      - `description` string, nullable, required
    - `removeMembers` Setting, required
      - `id` string, required
      - `name` string, required
      - `applied_to` 'organization' | 'workspace' | 'channel' | 'message', required
      - `description` string, nullable, required
    - `addOwners` Setting, required
      - `id` string, required
      - `name` string, required
      - `applied_to` 'organization' | 'workspace' | 'channel' | 'message', required
      - `description` string, nullable, required
    - `editName` Setting, required
      - `id` string, required
      - `name` string, required
      - `applied_to` 'organization' | 'workspace' | 'channel' | 'message', required
      - `description` string, nullable, required
    - `viewAdmins` Setting, required
      - `id` string, required
      - `name` string, required
      - `applied_to` 'organization' | 'workspace' | 'channel' | 'message', required
      - `description` string, nullable, required
    - `viewMembers` Setting, required
      - `id` string, required
      - `name` string, required
      - `applied_to` 'organization' | 'workspace' | 'channel' | 'message', required
      - `description` string, nullable, required
    - `viewOwners` Setting, required
      - `id` string, required
      - `name` string, required
      - `applied_to` 'organization' | 'workspace' | 'channel' | 'message', required
      - `description` string, nullable, required
    - `viewGuests` Setting, required
      - `id` string, required
      - `name` string, required
      - `applied_to` 'organization' | 'workspace' | 'channel' | 'message', required
      - `description` string, nullable, required
    - `editDescription` Setting, required
      - `id` string, required
      - `name` string, required
      - `applied_to` 'organization' | 'workspace' | 'channel' | 'message', required
      - `description` string, nullable, required
    - `viewDescription` Setting, required
      - `id` string, required
      - `name` string, required
      - `applied_to` 'organization' | 'workspace' | 'channel' | 'message', required
      - `description` string, nullable, required
    - `editImage` Setting, required
      - `id` string, required
      - `name` string, required
      - `applied_to` 'organization' | 'workspace' | 'channel' | 'message', required
      - `description` string, nullable, required
    - `canLeave` Setting, required
      - `id` string, required
      - `name` string, required
      - `applied_to` 'organization' | 'workspace' | 'channel' | 'message', required
      - `description` string, nullable, required
    - `canDelete` Setting, required
      - `id` string, required
      - `name` string, required
      - `applied_to` 'organization' | 'workspace' | 'channel' | 'message', required
      - `description` string, nullable, required
    - `canDeleteSentMessages` Setting, required
      - `id` string, required
      - `name` string, required
      - `applied_to` 'organization' | 'workspace' | 'channel' | 'message', required
      - `description` string, nullable, required
    - `canForwardMessages` Setting, required
      - `id` string, required
      - `name` string, required
      - `applied_to` 'organization' | 'workspace' | 'channel' | 'message', required
      - `description` string, nullable, required
    - `recordPreRecordedMessages` Setting, required
      - `id` string, required
      - `name` string, required
      - `applied_to` 'organization' | 'workspace' | 'channel' | 'message', required
      - `description` string, nullable, required
  - `WorkspaceSettings` WorkspaceSettings, required
    - `addMembers` Setting, required
      - `id` string, required
      - `name` string, required
      - `applied_to` 'organization' | 'workspace' | 'channel' | 'message', required
      - `description` string, nullable, required
    - `removeMembers` Setting, required
      - `id` string, required
      - `name` string, required
      - `applied_to` 'organization' | 'workspace' | 'channel' | 'message', required
      - `description` string, nullable, required
    - `addOwners` Setting, required
      - `id` string, required
      - `name` string, required
      - `applied_to` 'organization' | 'workspace' | 'channel' | 'message', required
      - `description` string, nullable, required
    - `editName` Setting, required
      - `id` string, required
      - `name` string, required
      - `applied_to` 'organization' | 'workspace' | 'channel' | 'message', required
      - `description` string, nullable, required
    - `viewAdmins` Setting, required
      - `id` string, required
      - `name` string, required
      - `applied_to` 'organization' | 'workspace' | 'channel' | 'message', required
      - `description` string, nullable, required
    - `viewMembers` Setting, required
      - `id` string, required
      - `name` string, required
      - `applied_to` 'organization' | 'workspace' | 'channel' | 'message', required
      - `description` string, nullable, required
    - `viewOwners` Setting, required
      - `id` string, required
      - `name` string, required
      - `applied_to` 'organization' | 'workspace' | 'channel' | 'message', required
      - `description` string, nullable, required
    - `viewGuests` Setting, required
      - `id` string, required
      - `name` string, required
      - `applied_to` 'organization' | 'workspace' | 'channel' | 'message', required
      - `description` string, nullable, required
    - `editDescription` Setting, required
      - `id` string, required
      - `name` string, required
      - `applied_to` 'organization' | 'workspace' | 'channel' | 'message', required
      - `description` string, nullable, required
    - `viewDescription` Setting, required
      - `id` string, required
      - `name` string, required
      - `applied_to` 'organization' | 'workspace' | 'channel' | 'message', required
      - `description` string, nullable, required
    - `editImage` Setting, required
      - `id` string, required
      - `name` string, required
      - `applied_to` 'organization' | 'workspace' | 'channel' | 'message', required
      - `description` string, nullable, required
    - `canLeave` Setting, required
      - `id` string, required
      - `name` string, required
      - `applied_to` 'organization' | 'workspace' | 'channel' | 'message', required
      - `description` string, nullable, required
    - `canDelete` Setting, required
      - `id` string, required
      - `name` string, required
      - `applied_to` 'organization' | 'workspace' | 'channel' | 'message', required
      - `description` string, nullable, required
    - `canDeleteSentMessages` Setting, required
      - `id` string, required
      - `name` string, required
      - `applied_to` 'organization' | 'workspace' | 'channel' | 'message', required
      - `description` string, nullable, required
    - `canForwardMessages` Setting, required
      - `id` string, required
      - `name` string, required
      - `applied_to` 'organization' | 'workspace' | 'channel' | 'message', required
      - `description` string, nullable, required
    - `recordPreRecordedMessages` Setting, required
      - `id` string, required
      - `name` string, required
      - `applied_to` 'organization' | 'workspace' | 'channel' | 'message', required
      - `description` string, nullable, required
    - `addChannels` Setting, required
      - `id` string, required
      - `name` string, required
      - `applied_to` 'organization' | 'workspace' | 'channel' | 'message', required
      - `description` string, nullable, required
    - `canSetWhoChangeConversationRetentionSettings` Setting, required
      - `id` string, required
      - `name` string, required
      - `applied_to` 'organization' | 'workspace' | 'channel' | 'message', required
      - `description` string, nullable, required
    - `canSetWhoMarkMessageToBePreserved` Setting, required
      - `id` string, required
      - `name` string, required
      - `applied_to` 'organization' | 'workspace' | 'channel' | 'message', required
      - `description` string, nullable, required
    - `canManageDomains` Setting, required
      - `id` string, required
      - `name` string, required
      - `applied_to` 'organization' | 'workspace' | 'channel' | 'message', required
      - `description` string, nullable, required
  - `ChannelSettings` ChannelSettings, required
    - `addMembers` Setting, required
      - `id` string, required
      - `name` string, required
      - `applied_to` 'organization' | 'workspace' | 'channel' | 'message', required
      - `description` string, nullable, required
    - `removeMembers` Setting, required
      - `id` string, required
      - `name` string, required
      - `applied_to` 'organization' | 'workspace' | 'channel' | 'message', required
      - `description` string, nullable, required
    - `addOwners` Setting, required
      - `id` string, required
      - `name` string, required
      - `applied_to` 'organization' | 'workspace' | 'channel' | 'message', required
      - `description` string, nullable, required
    - `editName` Setting, required
      - `id` string, required
      - `name` string, required
      - `applied_to` 'organization' | 'workspace' | 'channel' | 'message', required
      - `description` string, nullable, required
    - `viewAdmins` Setting, required
      - `id` string, required
      - `name` string, required
      - `applied_to` 'organization' | 'workspace' | 'channel' | 'message', required
      - `description` string, nullable, required
    - `viewMembers` Setting, required
      - `id` string, required
      - `name` string, required
      - `applied_to` 'organization' | 'workspace' | 'channel' | 'message', required
      - `description` string, nullable, required
    - `viewOwners` Setting, required
      - `id` string, required
      - `name` string, required
      - `applied_to` 'organization' | 'workspace' | 'channel' | 'message', required
      - `description` string, nullable, required
    - `viewGuests` Setting, required
      - `id` string, required
      - `name` string, required
      - `applied_to` 'organization' | 'workspace' | 'channel' | 'message', required
      - `description` string, nullable, required
    - `editDescription` Setting, required
      - `id` string, required
      - `name` string, required
      - `applied_to` 'organization' | 'workspace' | 'channel' | 'message', required
      - `description` string, nullable, required
    - `viewDescription` Setting, required
      - `id` string, required
      - `name` string, required
      - `applied_to` 'organization' | 'workspace' | 'channel' | 'message', required
      - `description` string, nullable, required
    - `editImage` Setting, required
      - `id` string, required
      - `name` string, required
      - `applied_to` 'organization' | 'workspace' | 'channel' | 'message', required
      - `description` string, nullable, required
    - `canLeave` Setting, required
      - `id` string, required
      - `name` string, required
      - `applied_to` 'organization' | 'workspace' | 'channel' | 'message', required
      - `description` string, nullable, required
    - `canDelete` Setting, required
      - `id` string, required
      - `name` string, required
      - `applied_to` 'organization' | 'workspace' | 'channel' | 'message', required
      - `description` string, nullable, required
    - `canDeleteSentMessages` Setting, required
      - `id` string, required
      - `name` string, required
      - `applied_to` 'organization' | 'workspace' | 'channel' | 'message', required
      - `description` string, nullable, required
    - `canForwardMessages` Setting, required
      - `id` string, required
      - `name` string, required
      - `applied_to` 'organization' | 'workspace' | 'channel' | 'message', required
      - `description` string, nullable, required
    - `recordPreRecordedMessages` Setting, required
      - `id` string, required
      - `name` string, required
      - `applied_to` 'organization' | 'workspace' | 'channel' | 'message', required
      - `description` string, nullable, required
    - `addMessages` Setting, required
      - `id` string, required
      - `name` string, required
      - `applied_to` 'organization' | 'workspace' | 'channel' | 'message', required
      - `description` string, nullable, required
    - `viewIsPrivate` Setting, required
      - `id` string, required
      - `name` string, required
      - `applied_to` 'organization' | 'workspace' | 'channel' | 'message', required
      - `description` string, nullable, required
    - `viewVisibility` Setting, required
      - `id` string, required
      - `name` string, required
      - `applied_to` 'organization' | 'workspace' | 'channel' | 'message', required
      - `description` string, nullable, required
    - `editVisibility` Setting, required
      - `id` string, required
      - `name` string, required
      - `applied_to` 'organization' | 'workspace' | 'channel' | 'message', required
      - `description` string, nullable, required
    - `changeMemberRole` Setting, required
      - `id` string, required
      - `name` string, required
      - `applied_to` 'organization' | 'workspace' | 'channel' | 'message', required
      - `description` string, nullable, required
    - `editSpans` Setting, required
      - `id` string, required
      - `name` string, required
      - `applied_to` 'organization' | 'workspace' | 'channel' | 'message', required
      - `description` string, nullable, required
    - `canChangeConversationRetention` Setting, required
      - `id` string, required
      - `name` string, required
      - `applied_to` 'organization' | 'workspace' | 'channel' | 'message', required
      - `description` string, nullable, required
    - `canPreserveMessages` Setting, required
      - `id` string, required
      - `name` string, required
      - `applied_to` 'organization' | 'workspace' | 'channel' | 'message', required
      - `description` string, nullable, required
    - `canSendMessages` Setting, required
      - `id` string, required
      - `name` string, required
      - `applied_to` 'organization' | 'workspace' | 'channel' | 'message', required
      - `description` string, nullable, required
  - `MessageSettings` MessageSettings, 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)