---
title: "View Group Information"
method: POST
path: "/pws/pws_group_list/"
tags: ["Group"]
---

# View Group Information

`POST /pws/pws_group_list/`

This API enables you to retrieve a list of all current groups or a specific group under your Client_ID. It proves to be particularly valuable when integrated into for example, a client middleware for card life cycle management. It can be utilized, for instance, to display the available group IDs that can be added in the create card API call or simply validating the existing group structure.

## Request body

- ListGroupModel — This web service allows to list groups
  - `api_call_unique_identifier` string, required — Unique number that must be passed at each API request. Identifier to make each API request unique
  - `client_id` integer, required — Unique identifier for the client which Paymentology will provide at outset
  - `user_id` string — User Id of the Customer who triggered the API request.
  - `remarks` string — Remarks for API request
  - `group_id` integer — group Id. Returns data for provided group Id only

## Response `200`

Successful Response

- GroupListResponseModel
  - `header` ResponseHeader
    - `error_id` integer — Error Id
    - `error_desc` string — Error Message
  - `body` GroupListResponseModelBody[]
    - `group_id` integer — group Id
    - `group_desc` string — group Description
    - `group_name` string — group Name
    - `group_type` string — group Type
    - `risk_level` string — Risk Level

## Other responses

- `404` — Webservices does not exist
- `500` — Internal Server error

---

[API](https://skmtc.net/paymentology/apis/payapi-docs.md) · [All operations](https://skmtc.net/paymentology/apis/payapi-docs/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/paymentology/payapi-docs/revisions/a675891b0365/schema)