---
title: "List south item groups"
method: GET
path: "/api/south/{southId}/groups"
tags: ["South Connectors"]
---

# List south item groups

`GET /api/south/{southId}/groups`

Lists all groups for a south connector

## Path parameters

- `southId` string, required

## Response `200`

Array of group objects

- SouthItemGroupDTO[]
  - `id` string, required — The unique identifier of the entity.
  - `createdBy` UserInfo, required — Represents the user who performed an action, with a computed display name.
    - `id` string, required — The unique identifier of the user.
    - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users.
  - `updatedBy` UserInfo, required — Represents the user who performed an action, with a computed display name.
    - `id` string, required — The unique identifier of the user.
    - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users.
  - `createdAt` string, required — Represents an instant in time as an ISO 8601 string.
  - `updatedAt` string, required — Represents an instant in time as an ISO 8601 string.
  - `standardSettings` object, required
    - `scanMode` ScanModeDTO, required — Data Transfer Object for a scan mode. Represents a configured scan mode with its metadata and schedule.
      - `id` string, required — The unique identifier of the entity.
      - `createdBy` UserInfo, required — Represents the user who performed an action, with a computed display name.
        - `id` string, required — The unique identifier of the user.
        - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users.
      - `updatedBy` UserInfo, required — Represents the user who performed an action, with a computed display name.
        - `id` string, required — The unique identifier of the user.
        - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users.
      - `createdAt` string, required — Represents an instant in time as an ISO 8601 string.
      - `updatedAt` string, required — Represents an instant in time as an ISO 8601 string.
      - `name` string, required — The name of the scan mode.
      - `description` string, required — A description of the scan mode's purpose or behavior.
      - `cron` string, required — A cron expression defining the scan schedule.
    - `name` string, required — The name of the group.
  - `historySettings` object, required
    - `recoveryStrategy` 'oldest' | 'newest', required — Recovery strategy used when a south connector reconnects after a long disconnection. - 'oldest': fill the gap from oldest to newest (default behaviour). - 'newest': fill the gap from newest to oldest so that recent data arrives first.
    - `readDelay` number, double, nullable, required — Read delay in milliseconds before querying historical data. Only applicable for connectors with historian capabilities.
    - `maxReadInterval` number, double, nullable, required — Maximum read interval in seconds for historical queries. Only applicable for connectors with historian capabilities.
    - `endTimeOffset` number, double, nullable, required — Offset in milliseconds applied to the end of the history query interval. Only applicable for connectors with historian capabilities. If the resulting end time is not after the effective start time, the query is skipped.
    - `startTimeOffset` number, double, nullable, required — Offset in milliseconds applied to the start of the history query interval. Only applicable for connectors with historian capabilities. Negative values extend the window backwards (equivalent to the old overlap behaviour).

---

[API](https://skmtc.net/optimistiksas/apis/oibus-api.md) · [All operations](https://skmtc.net/optimistiksas/apis/oibus-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/optimistiksas/oibus-api/versions/743d1b62f042/schema)