---
title: "List Inbox Notifications"
method: GET
path: "/inbox-notifications"
tags: ["Inbox Notifications"]
---

# List Inbox Notifications

`GET /inbox-notifications`

## Request

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

## Query parameters

- `skip` number
- `limit` number, nullable
- `direction` 'older' | 'newer'
- `category` 'workspace' | 'mentions' | 'carbonVoice' | 'security' | 'general'
- `type` 'workspace.user.added' | 'workspace.user.invited' | 'workspace.user.joined' | 'workspace.user.removed' | 'workspace.user.left' | 'workspace.findable-channel.created' | 'workspace.user.join.requested' | 'workspace.user.join.declined' | 'workspace.updated' | 'channel.user.joined' | 'channel.deleted' | 'channel.users.added' | 'channel.user.removed' | 'channel.user.left' | 'channel.updated' | 'channel.user.join.requested' | 'cv.user.joined' | 'general.new.update' | 'general.new.article' | 'general.user.tagged' | 'general.message.forwarded'
- `date` number

## Response `200`

- InboxNotificationResponse
  - `filters` InboxNotificationFilter, required
    - `skip` number
    - `limit` number, nullable: Max number of results allowed per page is: **100**
    - `direction` 'older' | 'newer'
    - `category` 'workspace' | 'mentions' | 'carbonVoice' | 'security' | 'general'
    - `type` 'workspace.user.added' | 'workspace.user.invited' | 'workspace.user.joined' | 'workspace.user.removed' | 'workspace.user.left' | 'workspace.findable-channel.created' | 'workspace.user.join.requested' | 'workspace.user.join.declined' | 'workspace.updated' | 'channel.user.joined' | 'channel.deleted' | 'channel.users.added' | 'channel.user.removed' | 'channel.user.left' | 'channel.updated' | 'channel.user.join.requested' | 'cv.user.joined' | 'general.new.update' | 'general.new.article' | 'general.user.tagged' | 'general.message.forwarded'
    - `date` number
  - `total_results` number, required
  - `total_unread` number, required
  - `results` InboxNotification[], required
    - `_id` string, required
    - `user_id` string, required
    - `type` 'workspace.user.added' | 'workspace.user.invited' | 'workspace.user.joined' | 'workspace.user.removed' | 'workspace.user.left' | 'workspace.findable-channel.created' | 'workspace.user.join.requested' | 'workspace.user.join.declined' | 'workspace.updated' | 'channel.user.joined' | 'channel.deleted' | 'channel.users.added' | 'channel.user.removed' | 'channel.user.left' | 'channel.updated' | 'channel.user.join.requested' | 'cv.user.joined' | 'general.new.update' | 'general.new.article' | 'general.user.tagged' | 'general.message.forwarded', required
    - `workspace_id` string, nullable
    - `channel_id` string, nullable
    - `from_user_id` string, nullable
    - `removed_user_id` string, nullable
    - `added_user_id` string, nullable
    - `declined_user_id` string, nullable
    - `message_id` string, nullable
    - `parent_message_id` string, nullable
    - `message` string, required
    - `created_at` string, date-time, required
    - `last_updated_at` string, date-time, required
    - `category` 'workspace' | 'mentions' | 'carbonVoice' | 'security' | 'general', required
    - `is_read` boolean, nullable
    - `action_url` string, nullable
    - `invite_users_info` InviteUsersInfo
      - `invite_type` 'email' | 'phone' | 'system' | 'all'
      - `invited_email` string, nullable
      - `invited_phone` string, nullable
      - `invited_user_id` string, nullable
      - `total_invited` number
      - `invited_token` string
    - `data_changed_info` DataChangedInfo
      - `data_changed_type` 'name' | 'color' | 'pattern' | 'domain', required
      - `entity_type` 'user' | 'workspace' | 'channel', required
      - `entity_id` string, nullable
      - `from_value` string, nullable
      - `to_value` string, nullable

---

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