---
title: "Get notifications for workspace"
description: "Retrieve all notifications for a specific workspace with filtering"
---

> Documentation Index
> Fetch the complete documentation index at: https://developer.channelautomations.com/llms.txt
> Use this file to discover all available pages before exploring further.

Path: Channel Automation API › Notifications

`GET /api/notifications/{workspaceId}`

Retrieve all notifications for a specific workspace with filtering

## Authentication

- `BearerAuth`, http, header `Authorization`, format `JWT`

## Path parameters

- `workspaceId` (`get/api/notifications/workspaceId.path.workspaceId`; string, required) — Workspace ID

## Query parameters

- `read` (`get/api/notifications/workspaceId.query.read`; boolean, optional) — Filter by read status
- `type` (`get/api/notifications/workspaceId.query.type`; string, optional) — Filter by notification type
  - one of `"info"`, `"success"`, `"warning"`, `"error"`
- `priority` (`get/api/notifications/workspaceId.query.priority`; string, optional) — Filter by priority level
  - one of `"low"`, `"medium"`, `"high"`, `"urgent"`
- `limit` (`get/api/notifications/workspaceId.query.limit`; integer, optional) — Number of items to return
  - min 1; max 100; default `50`
- `offset` (`get/api/notifications/workspaceId.query.offset`; integer, optional) — Number of items to skip
  - min 0; default `0`

## Code samples

### cURL

```bash
curl --request GET \
  --url 'https://api.channelautomation.com/api/notifications/<workspaceId>' \
  --header 'Authorization: Bearer <token>'
```

### TypeScript

```typescript
const url = 'https://api.channelautomation.com/api/notifications/<workspaceId>';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));
```

### Python

```python
import requests

url = "https://api.channelautomation.com/api/notifications/<workspaceId>"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
```

## Responses

### 200

Notifications retrieved successfully

#### Example

```json
{
  "success": true,
  "notifications": [
    {
      "id": "string",
      "workspace_id": "string",
      "title": "New Message Received",
      "message": "You have received a new message from John Doe",
      "type": "info",
      "priority": "medium",
      "read": false,
      "dismissed": false,
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  ],
  "total": 0,
  "unread_count": 0
}
```

- `success` (`get/api/notifications/workspaceId.response.200.success`; boolean, optional)
- `notifications` (`get/api/notifications/workspaceId.response.200.notifications`; array<object>, optional)
  - `id` (`get/api/notifications/workspaceId.response.200.notifications.id`; string, optional) — Unique notification identifier
  - `workspace_id` (`get/api/notifications/workspaceId.response.200.notifications.workspace_id`; string, optional) — Workspace ID
  - `title` (`get/api/notifications/workspaceId.response.200.notifications.title`; string, optional) — Notification title
    - example `"New Message Received"`
  - `message` (`get/api/notifications/workspaceId.response.200.notifications.message`; string, optional) — Notification message content
    - example `"You have received a new message from John Doe"`
  - `type` (`get/api/notifications/workspaceId.response.200.notifications.type`; string, optional) — Notification type
    - one of `"info"`, `"success"`, `"warning"`, `"error"`; example `"info"`
  - `priority` (`get/api/notifications/workspaceId.response.200.notifications.priority`; string, optional) — Notification priority level
    - one of `"low"`, `"medium"`, `"high"`, `"urgent"`; example `"medium"`
  - `read` (`get/api/notifications/workspaceId.response.200.notifications.read`; boolean, optional) — Whether notification has been read
    - default `false`
  - `dismissed` (`get/api/notifications/workspaceId.response.200.notifications.dismissed`; boolean, optional) — Whether notification has been dismissed
    - default `false`
  - `created_at` (`get/api/notifications/workspaceId.response.200.notifications.created_at`; string, optional) — Notification creation timestamp
    - format `date-time`
  - `updated_at` (`get/api/notifications/workspaceId.response.200.notifications.updated_at`; string, optional) — Last update timestamp
    - format `date-time`
- `total` (`get/api/notifications/workspaceId.response.200.total`; integer, optional) — Total number of notifications
- `unread_count` (`get/api/notifications/workspaceId.response.200.unread_count`; integer, optional) — Number of unread notifications

### 500

Server error


Source: https://developer.channelautomations.com/api/get-api-notifications-workspace-id/index.md