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

# List announcements

> List explicitly configured shared and app announcements. Shared announcements have appId null. Excludes environment overrides and deleted apps; inherited announcements are not duplicated. Ordered shared first, then by app ID.



## OpenAPI

````yaml https://api.theymes.com/v2/openapi.json get /announcements
openapi: 3.1.0
info:
  title: Theymes API v2
  version: 2.0.0
  description: >-
    Theymes API allows you to interact with the Theymes platform.



    Most endpoints require an API key for authentication. You can generate an
    API key in the Theymes dashboard.



    The API key should be included in the Authorization header
    (```Authorization: Bearer <YOUR_KEY>```).



    The public support link endpoints do not require authentication and are
    grouped separately below.
servers:
  - url: https://api.theymes.com/v2
security: []
tags:
  - name: Authenticated endpoints (API key)
    description: Endpoints that require an API key in the Authorization header.
  - name: Public support links (no authentication)
    description: >-
      Endpoints for creating web support sessions and links. These require no
      authentication and are identified by an app environment token.
paths:
  /announcements:
    get:
      tags:
        - Authenticated endpoints (API key)
      summary: List announcements
      description: >-
        List explicitly configured shared and app announcements. Shared
        announcements have appId null. Excludes environment overrides and
        deleted apps; inherited announcements are not duplicated. Ordered shared
        first, then by app ID.
      operationId: getAnnouncements
      parameters:
        - schema:
            type: string
            description: Bearer token API key
          required: true
          description: Bearer token API key
          name: Authorization
          in: header
      responses:
        '200':
          description: Configured announcements, or an empty list
          content:
            application/json:
              schema:
                type: object
                properties:
                  announcements:
                    type: array
                    items:
                      type: object
                      properties:
                        shortContent:
                          type: object
                          properties:
                            en:
                              type:
                                - string
                                - 'null'
                            de:
                              type:
                                - string
                                - 'null'
                            es:
                              type:
                                - string
                                - 'null'
                            es-AR:
                              type:
                                - string
                                - 'null'
                            es-MX:
                              type:
                                - string
                                - 'null'
                            fi:
                              type:
                                - string
                                - 'null'
                            fil:
                              type:
                                - string
                                - 'null'
                            fr:
                              type:
                                - string
                                - 'null'
                            id:
                              type:
                                - string
                                - 'null'
                            ja:
                              type:
                                - string
                                - 'null'
                            ko:
                              type:
                                - string
                                - 'null'
                            ms:
                              type:
                                - string
                                - 'null'
                            pt:
                              type:
                                - string
                                - 'null'
                            pt-BR:
                              type:
                                - string
                                - 'null'
                            ru:
                              type:
                                - string
                                - 'null'
                            tr:
                              type:
                                - string
                                - 'null'
                            uk:
                              type:
                                - string
                                - 'null'
                            vi:
                              type:
                                - string
                                - 'null'
                            zh:
                              type:
                                - string
                                - 'null'
                            zh-Hans:
                              type:
                                - string
                                - 'null'
                            zh-Hant:
                              type:
                                - string
                                - 'null'
                            ar:
                              type:
                                - string
                                - 'null'
                            cs:
                              type:
                                - string
                                - 'null'
                            da:
                              type:
                                - string
                                - 'null'
                            nl:
                              type:
                                - string
                                - 'null'
                            el:
                              type:
                                - string
                                - 'null'
                            hu:
                              type:
                                - string
                                - 'null'
                            it:
                              type:
                                - string
                                - 'null'
                            'no':
                              type:
                                - string
                                - 'null'
                            nb:
                              type:
                                - string
                                - 'null'
                            pl:
                              type:
                                - string
                                - 'null'
                            ro:
                              type:
                                - string
                                - 'null'
                            sk:
                              type:
                                - string
                                - 'null'
                            sv:
                              type:
                                - string
                                - 'null'
                            th:
                              type:
                                - string
                                - 'null'
                        longContent:
                          type: object
                          properties:
                            en:
                              type:
                                - string
                                - 'null'
                            de:
                              type:
                                - string
                                - 'null'
                            es:
                              type:
                                - string
                                - 'null'
                            es-AR:
                              type:
                                - string
                                - 'null'
                            es-MX:
                              type:
                                - string
                                - 'null'
                            fi:
                              type:
                                - string
                                - 'null'
                            fil:
                              type:
                                - string
                                - 'null'
                            fr:
                              type:
                                - string
                                - 'null'
                            id:
                              type:
                                - string
                                - 'null'
                            ja:
                              type:
                                - string
                                - 'null'
                            ko:
                              type:
                                - string
                                - 'null'
                            ms:
                              type:
                                - string
                                - 'null'
                            pt:
                              type:
                                - string
                                - 'null'
                            pt-BR:
                              type:
                                - string
                                - 'null'
                            ru:
                              type:
                                - string
                                - 'null'
                            tr:
                              type:
                                - string
                                - 'null'
                            uk:
                              type:
                                - string
                                - 'null'
                            vi:
                              type:
                                - string
                                - 'null'
                            zh:
                              type:
                                - string
                                - 'null'
                            zh-Hans:
                              type:
                                - string
                                - 'null'
                            zh-Hant:
                              type:
                                - string
                                - 'null'
                            ar:
                              type:
                                - string
                                - 'null'
                            cs:
                              type:
                                - string
                                - 'null'
                            da:
                              type:
                                - string
                                - 'null'
                            nl:
                              type:
                                - string
                                - 'null'
                            el:
                              type:
                                - string
                                - 'null'
                            hu:
                              type:
                                - string
                                - 'null'
                            it:
                              type:
                                - string
                                - 'null'
                            'no':
                              type:
                                - string
                                - 'null'
                            nb:
                              type:
                                - string
                                - 'null'
                            pl:
                              type:
                                - string
                                - 'null'
                            ro:
                              type:
                                - string
                                - 'null'
                            sk:
                              type:
                                - string
                                - 'null'
                            sv:
                              type:
                                - string
                                - 'null'
                            th:
                              type:
                                - string
                                - 'null'
                        appId:
                          type:
                            - string
                            - 'null'
                          format: uuid
                      required:
                        - shortContent
                        - longContent
                        - appId
                required:
                  - announcements
        '403':
          description: API key authentication required

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.