---
title: "GET /announcements"
method: GET
path: "/announcements"
tags: ["Announcements"]
---

# GET /announcements

`GET /announcements`

## Request

- Base URL: `https://sb2api.servicechannel.com/v3`
- URL: `https://sb2api.servicechannel.com/v3/announcements`
- Auth: OAuth 2
  - Authorization code: `https://sb2login.servicechannel.com/oauth/authorize`
  - Token URL: `https://sb2login.servicechannel.com/oauth/token`
- TypeScript: <https://skmtc.dev/servicechannel/apis/servicechannel-api-v-3/docs/announcements/get.ts> (a function with typed inputs; its response is checked against the schema)

## Response `200`

Request succeeded and the requested information is in the response.

- ServiceChannelServicesMessagingAnnouncementsGetUserAnnouncementsResponse
  - `UserAnnouncements` ServiceChannelApiModelEntitiesUserAnnouncements
    - `ReadAnnouncements` ServiceChannelApiModelEntitiesUserAnnouncement[]
      - `Id` integer
      - `Title` string
      - `AnnouncementType` 'NonModal' | 'Modal' | 'SCProviderMobile'
      - `CreatedDate` string, date-time
      - `CreatedById` integer
      - `MessageBody` string
      - `CallToAction` string
      - `ImageLink` string
      - `UrlLink` string
      - `ImageName` string
    - `UnreadAnnouncements` ServiceChannelApiModelEntitiesUserAnnouncement[]
      - `Id` integer
      - `Title` string
      - `AnnouncementType` 'NonModal' | 'Modal' | 'SCProviderMobile'
      - `CreatedDate` string, date-time
      - `CreatedById` integer
      - `MessageBody` string
      - `CallToAction` string
      - `ImageLink` string
      - `UrlLink` string
      - `ImageName` string
  - `ErrorCode` integer: Numeric identifier that determines the nature of an error. Possible values: `0` - success, otherwise - error.
  - `Message` string: Defines that the file’s remote storage is unavailable or its URL cannot be found.

## Other responses

- `400`: Bad Request - the request could not be understood or was missing required parameters. <br/>Error codes: <br/> 503 - User info should not be null; <br/>ProviderId is null;
- `401`: Unauthorized indicates that the requested resource requires authentication. <br/>Error codes: <br/> 504 - API call rejected by security permissions;

---

[API](https://skmtc.dev/servicechannel/apis/servicechannel-api-v-3.md) - [All operations](https://skmtc.dev/servicechannel/apis/servicechannel-api-v-3/llms.txt) - [OpenAPI document](https://skmtc.dev/servicechannel/apis/servicechannel-api-v-3/revisions/d490d6596809?raw)