---
title: "List Credential Distribution Groups"
method: GET
path: "/credential-distribution-groups"
tags: ["Administration"]
---

# List Credential Distribution Groups

`GET /credential-distribution-groups`

List a page of Credential Distribution Groups.

## Query parameters

- `page` integer
- `limit` integer
- `order` 'ASC' | 'DESC' — Sort Order
- `sortField` 'GROUP_NAME' | 'USER_ALLOWED'
- `keyword` string
- `userGroupIds` integer[]

## Response `200`

OK

- PagedXiqCredentialDistributionGroupUpdate
  - `page` integer, required — The current page number
  - `count` integer, required — The element count of the current page
  - `total_pages` integer, required — The total page number based on request page size
  - `total_count` integer, required — The total element count
  - `data` XiqCredentialDistributionGroupUpdate[] — The data in the current page
    - `id` integer, required — The unique identifier
    - `create_time` string, date-time, required — The create time in UTC (ISO 8601 format)
    - `update_time` string, date-time, required — The last update time in UTC (ISO 8601 format)
    - `org_id` integer — The organization identifier, valid when enabling HIQ feature
    - `owner_id` integer — The owner ID of the Credential Distribution group
    - `group_type` string — The Group type
    - `enable_email_approval` boolean — Whether email approval is enabled
    - `enable_user_limitation` boolean — Whether user limitation is enabled
    - `employee_group_type` 'ADMIN' | 'AD' | 'MANAGE' — Employee Group Json Type
    - `employee_groups` XiqEmployeeGroupUpdate[] — The member employee groups
      - `name` string — The employee group name
      - `id` integer — The employee group id
    - `name` string — The name of the credential distribution group
    - `restrict_number` string — Restriction on number of credentials per employee
    - `user_groups` XiqCdgUserGroups[] — The UserGroups
      - `id` integer, required — The unique identifier
      - `create_time` string, date-time, required — The create time in UTC (ISO 8601 format)
      - `update_time` string, date-time, required — The last update time in UTC (ISO 8601 format)
      - `org_id` integer — The organization identifier, valid when enabling HIQ feature
      - `owner_id` integer — The owner ID
      - `name` string — The User Group Name
      - `json_type` string — JSON Type
      - `description` string — The user group description
      - `password_rule_settings_id` integer — The password rule settings id
      - `delivery_policy_settings_id` integer — The delivery policy settings id
      - `time_expiration_settings_id` integer — The time expiration settings id
      - `user_count` integer — The user count
      - `ssids` string[] — The list of SSIDs
      - `group_type` string — The user group type
      - `pcg_use_only` boolean — Whether PCG use only is enabled
      - `ppsk_use_only` boolean — Whether PPSK use only is enabled
      - `enable_pcg_filter` boolean — Whether PCG filter is enabled
      - `enable_self_reg` boolean — Whether self reg is enabled
      - `enable_renew` boolean — Whether renew is enabled

---

[API](https://skmtc.net/extremecloudiq/apis/extremecloud-iq-api.md) · [All operations](https://skmtc.net/extremecloudiq/apis/extremecloud-iq-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/extremecloudiq/extremecloud-iq-api/versions/5ff7ab84e8e8/schema)