---
title: "Get current user info"
method: GET
path: "/whoami"
tags: ["Auth"]
---

# Get current user info

`GET /whoami`

## Request

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

## Response `200`

- WhoAmIResponse
  - `success` boolean, required
  - `settings` WhoAmISettings, required
    - `sharefeedback_workspace` string, required
    - `gate_code` string, nullable
    - `is_gated` boolean, required
    - `member_count` number, required
    - `admin_count` number, required
    - `owner_count` number, required
  - `user` UserDto, required
    - `user_guid` string, required
    - `uuid` string, required
    - `first_name` string, nullable
    - `last_name` string, nullable
    - `image_url` string, required
    - `created_by` string, nullable
    - `role` string, nullable
    - `created_ts` number, required
    - `last_updated_ts` number, required
    - `last_seen_ts` number, required
    - `timezone_offset_minutes` number, required
    - `is_verified` string, required
    - `is_allowed_through_gate` boolean, required
    - `phone_txt` string, nullable
    - `email_txt` string, nullable
    - `workspace_guids` string[], required
    - `identities` UserIdentity[], required
      - `user_guid` string, required
      - `provider_email` string, nullable
      - `provider` string, nullable
      - `provider_uid` string, nullable
      - `image_url` string, nullable
      - `first_name` string, nullable
      - `last_name` string, nullable
      - `is_verified` string, required
      - `provider_phone` string, nullable
    - `settings` object, required
    - `entries` UserEntryDto[], required
      - `entry_guid` string, required
      - `group_cd` 'CALLME' | 'EMAILME' | 'OTHER' | 'VIDEOME' | 'MESSAGEME' | 'SCHEDULEME' | 'COLLABORATE' | 'PAYME', required
      - `type_cd` string, required
      - `label_txt` string, required
      - `value_txt` string, required
      - `also_supports_mask` number, required
    - `last_seen_on` string, date-time, nullable
    - `plan_type` string, required
    - `notification_settings` NotificationSettings
      - `notify_by` NotifyBy, required
        - `DAILY_DIGEST` NotifyByMethods
          - `email` boolean
          - `sms` boolean
          - `push` boolean
        - `CONV_ADDED_NAMED` NotifyByMethods
          - `email` boolean
          - `sms` boolean
          - `push` boolean
        - `MSG_NEW` NotifyByMethods
          - `email` boolean
          - `sms` boolean
          - `push` boolean
        - `EMOTICON_RSP` NotifyByMethods
          - `email` boolean
          - `sms` boolean
          - `push` boolean
        - `MEET_NEW` NotifyByMethods
          - `email` boolean
          - `sms` boolean
          - `push` boolean
        - `MEET_UPDATE_CREATOR` NotifyByMethods
          - `email` boolean
          - `sms` boolean
          - `push` boolean
        - `MEET_UPDATE_MEMBER` NotifyByMethods
          - `email` boolean
          - `sms` boolean
          - `push` boolean
        - `MEET_ENDED` NotifyByMethods
          - `email` boolean
          - `sms` boolean
          - `push` boolean
        - `MEET_JOINED` NotifyByMethods
          - `email` boolean
          - `sms` boolean
          - `push` boolean
        - `WS_INVITE` NotifyByMethods
          - `email` boolean
          - `sms` boolean
          - `push` boolean
        - `WS_JOINED` NotifyByMethods
          - `email` boolean
          - `sms` boolean
          - `push` boolean
        - `WS_ADDED` NotifyByMethods
          - `email` boolean
          - `sms` boolean
          - `push` boolean
        - `ACTION_ITEM_ASSIGNED_TO_ME` NotifyByMethods
          - `email` boolean
          - `sms` boolean
          - `push` boolean
        - `ACTION_ITEM_DONE` NotifyByMethods
          - `email` boolean
          - `sms` boolean
          - `push` boolean
        - `CHANNEL_REMINDER` NotifyByMethods
          - `email` boolean
          - `sms` boolean
          - `push` boolean
      - `primary_notification_email` string: Primary email notification (Will be used to send notifications)
      - `primary_notification_phone` string: Primary sms notification (Will be used to send notifications)
      - `product_notification_email` string: Primary Product email notification (Will be used to send product notifications)
      - `conversation_settings` ConversationSettings[]: Conversation Settings
        - `channel_id` string, required: Channel ID
        - `state` 'normal' | 'muted', required: Notification State
        - `sound_standard` string, nullable: Standard Message Sound
        - `sound_urgent` string, nullable: Urgent Message Sound
        - `sound_reply` string, nullable: Reply Message Sound
    - `environments` UserEnvironment[], required
      - `name` string, required
      - `apiUrl` string, required
      - `wsUrl` string, required
    - `languages` string[], required
    - `voice_gender` 'F' | 'M'
    - `voice_id` string, nullable
    - `has_fcm_token` boolean, required
    - `tts_mode` 'cloned_voice' | 'standard' | 'premium', required
    - `translation_mode` 'not_specified' | 'none' | 'tts' | 'dubbing', required
    - `preserve_senders_voice` boolean, required
    - `lifecycle_events` LifecycleEvent[], required
      - `type` 'Login' | 'UsedDiscussionLink' | 'IdentityAddded' | 'CreatedPlaylist' | 'CreatedWorkspace' | 'CreatedPersonalCarbonLink' | 'NotifiedMessageAccess' | 'VoiceMemoCreated' | 'ConversationMessageCreated' | 'DowngradedToLowerPlan' | 'AIResponseGenerated' | 'JoinedConversation' | 'JoinedWorkspace' | 'PersonalizedTTS' | 'DownloadedApp' | 'CheckedUsers' | 'SetPhoto' | 'InvitedUser' | 'WatchedGestureGuide' | 'WatchedWelcomeVideo', required
      - `times` number, required
    - `user_type` 'user' | 'bot' | 'agent', required
    - `is_agent` boolean, required
    - `owner_id` string, nullable, required
  - `pxtoken` string, nullable, 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)