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

# Get Tap Groups

> Returns tap groups for a nonprofit based on the provided filters.



## OpenAPI

````yaml https://server.stage.overflow.co/api/docs/openapi.json get /api/v3/tap/groups
openapi: 3.0.0
info:
  title: Overflow Open API
  description: |

    The documentation for the Overflow Open APIs.

    To access the OpenAPI spec in JSON/YAML format, navigate to:

    * `/api/docs/openapi.json`
    * `/api/docs/openapi.yaml`
  version: '3.0'
  contact: {}
servers:
  - url: https://server.stage.overflow.co
    description: API server
security: []
tags: []
paths:
  /api/v3/tap/groups:
    get:
      tags:
        - Tap
      summary: Get Tap Groups
      description: Returns tap groups for a nonprofit based on the provided filters.
      operationId: OpenApiTapGroupsController_getGroups
      parameters:
        - name: limit
          required: false
          in: query
          description: The number of tap groups to return.
          schema:
            minimum: 1
            maximum: 100
            default: 25
            type: number
        - name: page
          required: false
          in: query
          description: The page number of the tap groups to return.
          schema:
            minimum: 1
            default: 1
            type: number
        - name: search
          required: false
          in: query
          description: Search tap groups by name.
          schema:
            example: Sunday Service
            type: string
        - name: includeArchived
          required: false
          in: query
          description: Whether to include tap groups that have been archived.
          schema:
            type: boolean
        - name: sortBy
          required: false
          in: query
          description: The field to sort the tap groups by.
          schema:
            default: createdAt
            example: createdAt
            enum:
              - name
              - createdAt
            type: string
        - name: sortDirection
          required: false
          in: query
          description: The direction to sort the tap groups by.
          schema:
            default: DESC
            example: DESC
            enum:
              - ASC
              - DESC
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetTapGroupsResponse'
      security:
        - ClientId: []
          ApiKey: []
components:
  schemas:
    GetTapGroupsResponse:
      type: object
      properties:
        data:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                description: Group ID
                example: 6710f34fd5061afeec3eab58
              name:
                type: string
                description: Group name
                example: Sunday Service Group
              destinationId:
                type: string
                description: ID of the assigned destination
                example: 6710f34fd5061afeec3eab57
              destination:
                type: object
                properties:
                  id:
                    type: string
                    description: Destination ID
                    example: 6710f34fd5061afeec3eab57
                  name:
                    type: string
                    description: Destination name
                    example: Main Giving Page
                  type:
                    type: string
                    enum:
                      - web
                      - sms
                    nullable: true
                    description: Destination type
                    example: web
                  url:
                    type: string
                    nullable: true
                    description: Redirect URL for web destinations
                    example: https://example.com/give
                  textNumber:
                    type: string
                    nullable: true
                    description: Phone number for SMS destinations
                    example: null
                  textContent:
                    type: string
                    nullable: true
                    description: SMS message body
                    example: null
                required:
                  - id
                  - name
                  - type
                  - url
                  - textNumber
                  - textContent
                nullable: true
                description: Embedded destination info
              deviceIds:
                type: array
                items:
                  type: string
                nullable: true
                description: IDs of devices assigned to this group
                example:
                  - 6710f34fd5061afeec3eab59
              createdAt:
                type: string
                format: date-time
                description: Record creation timestamp
                example: '2026-05-01T17:22:11.421Z'
              updatedAt:
                type: string
                format: date-time
                description: Record last updated timestamp
                example: '2026-05-04T14:09:32.145Z'
              archivedAt:
                type: string
                format: date-time
                nullable: true
                description: Archive timestamp, null if active
            required:
              - id
              - name
              - destinationId
              - destination
              - deviceIds
              - createdAt
              - updatedAt
              - archivedAt
          description: List of tap groups.
        totalCount:
          type: number
          description: Total number of tap groups matching the filters.
          example: 100
      required:
        - data
        - totalCount
  securitySchemes:
    ClientId:
      type: apiKey
      in: header
      name: x-client-id
      description: Client ID for API authentication
    ApiKey:
      type: apiKey
      in: header
      name: x-api-key
      description: API Key for API authentication

````