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

# Get Announcements

> Returns a paginated list of announcements for your company, ordered by most recent first.

<Info>
  Both `page` and `items_per_page` are optional. If omitted, the API returns the first page with the default page size.
</Info>


## OpenAPI

````yaml api-reference/v01.12.00/openapi-v01.12.00.json GET /announcements
openapi: 3.0.0
info:
  title: Roosted
  version: 0.1.12
  contact:
    name: Support
    url: https://support.roostedhr.com/support/home
    email: support@roostedhr.com
  description: |-
    Enterprise API

    Sandbox keys and Production keys are requested from support
servers:
  - url: https://api.roostedhr.com/api/1_12
  - url: https://sandbox.roostedhr.com/api/1_12
security:
  - X-API-KEY: []
tags:
  - name: Announcements
  - name: Areas
  - name: Clients
  - name: Company
  - name: Configuration
  - name: Events
  - name: Locations
  - name: Payroll Groups
  - name: Rate Cards
  - name: Shifts
  - name: Skillsets
  - name: Time Tracking
  - name: Wage Rules
  - name: Workers
paths:
  /announcements:
    get:
      tags:
        - Announcements
      summary: Get Announcements
      description: >-
        Returns a paginated list of announcements for your company, ordered by
        most recent first.
      operationId: get-announcements
      parameters:
        - schema:
            type: integer
            default: 1
            example: 1
          in: query
          name: page
          description: Page number to retrieve.
        - schema:
            type: integer
            default: 25
            example: 25
          in: query
          name: items_per_page
          description: Number of announcements per page.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  announcements:
                    type: array
                    description: List of announcements for the current page.
                    items:
                      $ref: '#/components/schemas/Announcement'
                  total:
                    type: integer
                    description: Total number of announcements across all pages.
                    example: 42
              examples: {}
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: string
                    description: Machine-readable error code.
                  error:
                    type: string
                    description: Human-readable error message.
              examples:
                Invalid page parameter:
                  value:
                    code: ANN-100
                    error: Invalid page parameter
                Invalid items_per_page parameter:
                  value:
                    code: ANN-200
                    error: Invalid items_per_page parameter
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: string
                    description: Machine-readable error code.
                  error:
                    type: string
                    description: Human-readable error message.
              examples:
                Invalid API key:
                  value:
                    code: ATH-100
                    error: Invalid or missing API key
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: string
                    description: Machine-readable error code.
                  error:
                    type: string
                    description: Human-readable error message.
              examples:
                Insufficient permissions:
                  value:
                    code: ANN-700
                    error: Insufficient permissions to view announcements
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: string
                    description: Machine-readable error code.
                  error:
                    type: string
                    description: Human-readable error message.
              examples:
                Announcement not found:
                  value:
                    code: ANN-800
                    error: Announcement not found
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: string
                    description: Machine-readable error code.
                  error:
                    type: string
                    description: Human-readable error message.
              examples:
                Internal server error:
                  value:
                    code: ANN-1000
                    error: An unexpected error occurred
components:
  schemas:
    Announcement:
      title: Announcement
      description: An announcement sent to workers via email, text message, or both.
      type: object
      properties:
        id:
          type: integer
          description: Unique identifier for the announcement.
          example: 1542
        subject:
          type: string
          description: Subject line of the announcement.
          example: Schedule update for next week
        message:
          type: string
          description: Body content of the announcement. May contain HTML.
          example: <p>Please review your updated shifts for next week.</p>
        replies:
          type: array
          description: List of admin IDs designated to receive worker replies.
          items:
            type: integer
          example:
            - 3158
            - 3201
        selected_workers:
          type: array
          description: >-
            Workers the announcement was sent to. Empty when sent to all
            workers.
          items:
            type: object
            properties:
              id:
                type: integer
                description: Worker ID.
              name:
                type: string
                description: Worker full name.
          example:
            - id: 4521
              name: Jane Smith
            - id: 4587
              name: Carlos Rivera
        sent_via:
          type: array
          description: Delivery channels used for the announcement.
          items:
            type: string
            enum:
              - email
              - text message
          example:
            - email
            - text message
        status:
          type: string
          description: Current delivery status of the announcement.
          enum:
            - pending
            - sent
          example: sent
        time_sent:
          type: string
          description: Timestamp when the announcement was sent.
          example: '2026-03-15 14:30:00'
  securitySchemes:
    X-API-KEY:
      name: X-API-KEY
      type: apiKey
      in: header

````