---
title: "GET /api/scan-groups"
method: GET
path: "/api/scan-groups"
tags: ["api", "scan-groups"]
---

# GET /api/scan-groups

`GET /api/scan-groups`

Get All Scan Groups

## Query parameters

- `top` integer — A limit on the number of objects to be returned. Can range between 1 and 1000.
- `skip` integer — The number of objects to skip for the requested result
- `name` string — The filter by name.

## Response `200`

OK

- object
  - `docs` ScanGroupResource[], required
    - `_id` string, required — The ID of the scan group.
    - `name` string, required — The name of the scan group.
    - `sellerId` string, required — The ID of the seller of the scan group.
    - `scanConfig` object — The scan configuration of the scan group.
      - `mode` 'lock' | 'default', required — The mode of the scan config.
      - `events` object[] — The events settings of the scan config.
        - `eventId` string, required — The ID of the event.
        - `allowAllTicketTypes` boolean — Whether an all ticket type available or not.
        - `allowedTicketTypeIds` string[] — The array of the allowed ticket type IDs.
        - `timeslotSettings` object
          - `beforeMinutes` number — Minutes before a timeslot when tickets become valid for this event.
          - `afterMinutes` number — Minutes after a timeslot when tickets remain valid for this event.
      - `scanZoneId` string — The ID of the scan zone.
      - `scanTypes` union — The scan types enabled on the device. At least one of checkin or checkout must be true.
        - object
          - `checkin` true, required — Whether check-in scanning is enabled.
          - `checkout` boolean, required — Whether check-out scanning is enabled.
        - object
          - `checkin` false, required — Whether check-in scanning is enabled.
          - `checkout` true, required — Whether check-out scanning is enabled.
      - `enableMultiCheckin` boolean — Whether a ticket is allowed to be checked in more than once, given the corresponding count of checkouts were created.
      - `checkTimeslots` boolean — Whether to validate the ticket's timeslot against the current time.
      - `tapAndGo` object — The tap and go configuration of the scan group.
        - `enabled` boolean, required — Whether tap and go is enabled.
        - `eventIds` string[] — The IDs of events available for tap and go selection.
    - `deviceSettings` object — The device behaviour settings of the scan group.
      - `colorSettings` object — The color overrides for each scan feedback type.
        - `success` 'green' — The color shown for a success scan result. Fixed to green and cannot be overridden.
        - `declined` 'red' — The color shown for a declined scan result. Fixed to red and cannot be overridden.
        - `repeated` 'green' | 'orange' | 'red' | 'blue' | 'pink' — The color shown for a repeated scan result.
        - `highlighted` 'green' | 'orange' | 'red' | 'blue' | 'pink' — The color shown for a highlighted scan result.
        - `actionRequired` 'green' | 'orange' | 'red' | 'blue' | 'pink' — The color shown for a actionRequired scan result.
      - `enableSoundFeedback` boolean — Whether scan sound feedback is enabled.
      - `enableHapticFeedback` boolean — Whether haptic feedback is enabled.
      - `scanRevealInterval` 1 | 3 | 5 | 10 | 15 | 30 — The scan result display duration in seconds.
      - `ticketSyncInterval` 5 | 15 | 30 | 60 | 300 | 600 | 900 — The ticket data synchronization interval in seconds.
    - `createdAt` string, date-time, required — An ISO Timestamp indicating when the resource was created.
    - `updatedAt` string, date-time, required — An ISO Timestamp indicating when the resource was updated.
  - `total` number, required

## Other responses

- `400` — Bad Request
- `401` — Unauthorized

---

[API](https://skmtc.net/vivenu/apis/vivenu-api.md) · [All operations](https://skmtc.net/vivenu/apis/vivenu-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/vivenu/vivenu-api/revisions/36be0dca14e7/schema)