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

# List the workspace's Slack announcement channel groups and the channels in each right now (admin). A group is a rule on channel names, channels picked by hand, or the customer channels Dench mapped to their workspaces. Read only: it cannot send an announcement or change a group

> List the workspace's Slack announcement channel groups and the channels in each right now (admin). A group is a rule on channel names, channels picked by hand, or the customer channels Dench mapped to their workspaces. Read only: it cannot send an announcement or change a group.



## OpenAPI

````yaml /api-reference/openapi.json get /settings/announcement-groups
openapi: 3.1.0
info:
  title: Dench API
  version: 1.0.0
  description: >-
    Versioned Dench workspace API. The operation registry is shared with the
    Dench CLI parity layer, so every CLI command maps to an endpoint here.
servers:
  - url: https://www.dench.com/api/v1
security: []
tags:
  - name: agent-config
    description: Agent Config operations.
  - name: apps
    description: Apps operations.
  - name: auth
    description: Auth operations.
  - name: billing
    description: Billing operations.
  - name: browser
    description: Browser operations.
  - name: campaigns
    description: Campaigns operations.
  - name: chat
    description: Chat operations.
  - name: crm
    description: Crm operations.
  - name: email
    description: Email operations.
  - name: environments
    description: Environments operations.
  - name: files
    description: Files operations.
  - name: gateway
    description: Gateway operations.
  - name: lists
    description: Lists operations.
  - name: local
    description: Local operations.
  - name: meetings
    description: Meetings operations.
  - name: members
    description: Members operations.
  - name: memory
    description: Memory operations.
  - name: meta
    description: Meta operations.
  - name: notifications
    description: Notifications operations.
  - name: routines
    description: Routines operations.
  - name: secrets
    description: Secrets operations.
  - name: settings
    description: Settings operations.
  - name: workspace
    description: Workspace operations.
paths:
  /settings/announcement-groups:
    get:
      tags:
        - settings
      summary: >-
        List the workspace's Slack announcement channel groups and the channels
        in each right now (admin). A group is a rule on channel names, channels
        picked by hand, or the customer channels Dench mapped to their
        workspaces. Read only: it cannot send an announcement or change a group
      description: >-
        List the workspace's Slack announcement channel groups and the channels
        in each right now (admin). A group is a rule on channel names, channels
        picked by hand, or the customer channels Dench mapped to their
        workspaces. Read only: it cannot send an announcement or change a group.
      operationId: settings_announcementGroups_list
      parameters:
        - name: group
          in: query
          required: false
          schema:
            description: >-
              One group's name (any case): only that group, with every channel
              in it.
            type: string
            maxLength: 40
          description: >-
            One group's name (any case): only that group, with every channel in
            it.
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  slack:
                    type: string
                    enum:
                      - connected
                      - not_connected
                      - account_not_linked
                    description: >-
                      connected: each group's channels were read from Slack.
                      Otherwise the groups are named without channels and notes
                      says why.
                  groups:
                    type: array
                    items:
                      type: object
                      properties:
                        name:
                          type: string
                        kind:
                          type: string
                          enum:
                            - rule
                            - picked
                            - customer_channels
                          description: >-
                            rule: every channel whose name matches the rule, now
                            and later. picked: channels chosen by hand.
                            customer_channels: the channels shared with
                            customers that Dench mapped to their workspaces; it
                            follows that mapping and can only be renamed or
                            deleted.
                        rule:
                          description: >-
                            A rule group's rule: dench-* starts with dench-,
                            *-acme ends with -acme, a bare word is found
                            anywhere, a comma means or.
                          type: string
                        channelCount:
                          description: Channels in the group right now.
                          type: number
                        channels:
                          type: array
                          items:
                            type: object
                            properties:
                              name:
                                type: string
                              isPrivate:
                                type: boolean
                                const: true
                              isShared:
                                description: >-
                                  Slack Connect: people from another company are
                                  in it.
                                type: boolean
                                const: true
                            required:
                              - name
                            additionalProperties: false
                        privateChannelsNotNamed:
                          description: Private channels in it that are counted, not named.
                          type: number
                        channelsNotListed:
                          description: >-
                            Channels in it past the names one answer carries;
                            ask for the group by name to see all.
                          type: number
                        leftOutCount:
                          description: Channels its rule matches that the group leaves out.
                          type: number
                        leftOut:
                          type: array
                          items:
                            type: object
                            properties:
                              name:
                                type: string
                              isPrivate:
                                type: boolean
                                const: true
                              isShared:
                                description: >-
                                  Slack Connect: people from another company are
                                  in it.
                                type: boolean
                                const: true
                            required:
                              - name
                            additionalProperties: false
                      required:
                        - name
                        - kind
                      additionalProperties: false
                  notes:
                    type: array
                    items:
                      type: string
                    description: What the answer leaves out, in plain sentences.
                required:
                  - slack
                  - groups
                  - notes
                additionalProperties: false
                description: >-
                  Settings → Dench in Slack → Announcements: the saved channel
                  groups and the channels a send from the Dench app reaches in
                  each.
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalError'
      security:
        - DenchApiKey: []
        - AgentSession: []
components:
  responses:
    BadRequest:
      description: Invalid request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    Unauthorized:
      description: Missing or invalid authentication
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    NotFound:
      description: Operation or resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    InternalError:
      description: Server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
  schemas:
    ApiError:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - message
            - type
            - code
          properties:
            message:
              type: string
            type:
              type: string
            code:
              type: string
            details: {}
  securitySchemes:
    DenchApiKey:
      type: http
      scheme: bearer
      bearerFormat: DENCH_API_KEY
      description: >-
        Workspace-scoped Dench API key from workspace settings. This is the same
        key used by DENCH_API_KEY in sandboxes.
    AgentSession:
      type: http
      scheme: bearer
      bearerFormat: dch_agent_*
      description: >-
        Agent session token created by `dench signin`. Gateway-backed routes
        exchange this token for the workspace gateway key.

````

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