---
title: "Get Admin Groups"
method: GET
path: "/platform/adminuser/groups"
tags: ["AdminGroup"]
---

# Get Admin Groups

`GET /platform/adminuser/groups`

Gets a collection of user groups

## Query parameters

- `startIndex` integer
- `pageSize` integer
- `sortBy` string
- `filter` string
- `responseFields` string

## Response `200`

OK

- AdminGroupCollection
  - `items` AdminGroup[], nullable
    - `auditInfo` AdminUserAuditInfo
      - `createBy` string, nullable
      - `createDate` string, date-time, nullable
      - `updateBy` string, nullable
      - `updateDate` string, date-time, nullable
    - `description` string, nullable — Human-readable description of the group
    - `groupCode` string, nullable — User Group Id
    - `name` string, nullable — Human-readable Name of the group
    - `scopeId` integer — Scope Id
    - `scopeTypeId` integer — Scope Type Id
    - `users` User[], nullable — Users associate with a group
      - `emailAddress` string, nullable
      - `externalId` string, nullable
      - `firstName` string, nullable
      - `id` string, nullable
      - `identityProviderId` string, nullable
      - `isActive` boolean
      - `lastName` string, nullable
      - `localeCode` string, nullable
      - `optInToEmail` boolean, nullable
      - `optInToTextMessage` boolean, nullable
      - `password` string, nullable
      - `phoneNumber` string, nullable
      - `roles` UserRole[], nullable
        - `assignedInScope` UserScope
          - `id` integer, nullable
          - `name` string, nullable
          - `type` string, nullable
        - `auditInfo` AdminUserAuditInfo
          - `createBy` string, nullable
          - `createDate` string, date-time, nullable
          - `updateBy` string, nullable
          - `updateDate` string, date-time, nullable
        - `roleId` integer
        - `roleName` string, nullable
        - `roleResources` Resource[], nullable
          - `id` string, nullable
          - `type` string, nullable
        - `roleTags` string[], nullable
        - `userId` string, nullable
      - `systemData` UserSystemData
        - `createdOn` string, date-time, nullable
        - `failedLoginAttemptCount` integer
        - `firstFailedLoginAttemptOn` string, date-time, nullable
        - `isLocked` boolean
        - `isPasswordChangeRequired` boolean
        - `lastLockedOn` string, date-time, nullable
        - `lastLoginOn` string, date-time, nullable
        - `lastPasswordChangeOn` string, date-time, nullable
        - `remainingLoginAttempts` integer
        - `updatedOn` string, date-time, nullable
      - `userName` string, nullable
  - `pageCount` integer
  - `pageSize` integer
  - `startIndex` integer
  - `totalCount` integer

---

[API](https://skmtc.net/kibocommerce/apis/customer.md) · [All operations](https://skmtc.net/kibocommerce/apis/customer/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/kibocommerce/customer/versions/47c0cf7b75ab/schema)