> ## 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 Devices

> Returns tap devices for a nonprofit based on the provided filters. The search parameter matches by exact serial number, not fuzzy text search.



## OpenAPI

````yaml https://server.stage.overflow.co/api/docs/openapi.json get /api/v3/tap/devices
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/devices:
    get:
      tags:
        - Tap
      summary: Get Tap Devices
      description: >-
        Returns tap devices for a nonprofit based on the provided filters. The
        search parameter matches by exact serial number, not fuzzy text search.
      operationId: OpenApiTapDevicesController_getDevices
      parameters:
        - name: limit
          required: false
          in: query
          description: The number of tap devices to return.
          schema:
            minimum: 1
            maximum: 100
            default: 25
            type: number
        - name: page
          required: false
          in: query
          description: The page number of the tap devices to return.
          schema:
            minimum: 1
            default: 1
            type: number
        - name: search
          required: false
          in: query
          description: Search by exact serial number. Must be a numeric value.
          schema:
            pattern: ^\d+$
            example: '12345'
            type: string
        - name: groupId
          required: false
          in: query
          description: >-
            Filter tap devices by group Id. Use "unassigned" to get devices not
            assigned to any group.
          schema:
            example: 6710f34fd5061afeec3eab58
            oneOf:
              - type: string
                enum:
                  - unassigned
              - type: string
                pattern: ^[0-9a-fA-F]{24}$
        - name: deviceType
          required: false
          in: query
          description: Filter tap devices by device type.
          schema:
            example: Stand
            enum:
              - Lanyard
              - Stand
              - Bracelet
              - Wristband
              - Plates/Disc/Magnet/Label
              - Flex
              - Plate Square
              - Arm Rest Rectangle
              - Plates
              - Disc
              - Magnet
              - Label
            type: string
        - name: includeArchived
          required: false
          in: query
          description: Whether to include tap devices that have been archived.
          schema:
            type: boolean
        - name: sortBy
          required: false
          in: query
          description: The field to sort the tap devices by.
          schema:
            default: createdAt
            example: createdAt
            enum:
              - serialNumber
              - createdAt
            type: string
        - name: sortDirection
          required: false
          in: query
          description: The direction to sort the tap devices by.
          schema:
            default: DESC
            example: DESC
            enum:
              - ASC
              - DESC
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetTapDevicesResponse'
      security:
        - ClientId: []
          ApiKey: []
components:
  schemas:
    GetTapDevicesResponse:
      type: object
      properties:
        data:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                description: Device ID
                example: 6816f7ce7d2a1b4c12ab3501
              serialNumber:
                type: number
                description: Device serial number
                example: 104233
              deviceType:
                type: string
                enum:
                  - Lanyard
                  - Stand
                  - Bracelet
                  - Wristband
                  - Plates/Disc/Magnet/Label
                  - Flex
                  - Plate Square
                  - Arm Rest Rectangle
                  - Plates
                  - Disc
                  - Magnet
                  - Label
                description: Device form factor (e.g., Lanyard, Stand, Bracelet)
                example: Lanyard
              groupId:
                type: string
                nullable: true
                description: Group ID (null if unassigned)
              group:
                type: object
                properties:
                  id:
                    type: string
                    description: Group ID
                  name:
                    type: string
                    description: Group name
                required:
                  - id
                  - name
                nullable: true
                description: Embedded group (null if unassigned)
              currentDestination:
                type: object
                properties:
                  id:
                    type: string
                    description: Destination ID
                  name:
                    type: string
                    description: Destination name
                  type:
                    type: string
                    enum:
                      - web
                      - sms
                    nullable: true
                    description: Destination type
                required:
                  - id
                  - name
                  - type
                nullable: true
                description: Current destination via group (null if unassigned)
              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
              - serialNumber
              - deviceType
              - groupId
              - group
              - currentDestination
              - createdAt
              - updatedAt
              - archivedAt
          description: List of tap devices.
        totalCount:
          type: number
          description: Total number of tap devices 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

````