---
title: "GET /resource/{tenantLocator}/groups/list"
method: GET
path: "/resource/{tenantLocator}/groups/list"
---

# GET /resource/{tenantLocator}/groups/list

`GET /resource/{tenantLocator}/groups/list`

## Request

- Base URL: `https://docs.socotra.com`
- URL: `https://docs.socotra.com/resource/{tenantLocator}/groups/list`
- Auth: none declared
- TypeScript: <https://skmtc.dev/socotra/apis/socotra-insurance-suite-openapi/docs/resource/:tenantLocator/groups/list/get.ts> (a function with typed inputs; its response is checked against the schema)

## Path parameters

- `tenantLocator` string, uuid, required

## Query parameters

- `offset` integer
- `count` integer
- `excludeRetired` boolean
- `excludeActive` boolean

## Response `200`

OK

- ResourceGroupListResponse
  - `listCompleted` boolean, required
  - `items` ResourceGroupResponse[], required
    - `locator` string, ulid, required
    - `name` string, required
    - `retired` boolean, required
    - `selectionStartTime` string, date-time, required
    - `resourceNames` string[], required
    - `createdBy` string, uuid, required
    - `createdAt` string, date-time, required

---

[API](https://skmtc.dev/socotra/apis/socotra-insurance-suite-openapi.md) - [All operations](https://skmtc.dev/socotra/apis/socotra-insurance-suite-openapi/llms.txt) - [OpenAPI document](https://skmtc.dev/socotra/apis/socotra-insurance-suite-openapi/revisions/77ee7d8172b9?raw)