---
title: "Return a list of Groups for a Client."
method: GET
path: "/Ams/{ClientID}/Groups"
tags: ["Ams"]
---

# Return a list of Groups for a Client.

`GET /Ams/{ClientID}/Groups`

## Request

- Base URL: `https://ws.yourmembership.com`
- URL: `https://ws.yourmembership.com/Ams/{ClientID}/Groups`
- Auth: HTTP basic
- TypeScript: <https://skmtc.dev/yourmembership/apis/ym-rest-services/docs/Ams/:ClientID/Groups/get.ts> (a function with typed inputs; its response is checked against the schema)

Return a list of Groups for a Client.

## Path parameters

- `ClientID` integer, required

## Query parameters

- `GroupID` integer
- `GroupCode` string
- `TypeID` integer
- `Name` string
- `Active` boolean
- `Hidden` boolean
- `Accessibility` integer
- `Membership` integer
- `Messaging` integer
- `SendNewsletter` boolean
- `EnableFeed` boolean
- `AdminCanExportMembers` boolean
- `PhotoApproval` boolean
- `EmailOptionsAdmin` integer
- `EmailOptionsMember` integer
- `ShortDescription` string
- `WelcomeContent` string
- `UsingRedis` boolean
- `AppInitTime` string, date-time
- `ServerID` string
- `ResponseStatus` string
- `BypassCache` boolean
- `DateCached` string, date-time
- `Device` string

## Response `200`

Success

- GroupsResponse: GroupsResponse
  - `GroupTypeList` GroupType[]
    - `Id` integer
    - `TypeName` string
    - `SortIndex` number, double
    - `Groups` Group[]
      - `Id` integer
      - `Name` string
      - `Status` string
      - `JoinOption` string
  - `GroupID` integer
  - `GroupCode` string
  - `TypeID` integer
  - `Name` string
  - `Active` boolean
  - `Hidden` boolean
  - `Accessibility` integer
  - `Membership` integer
  - `Messaging` integer
  - `SendNewsletter` boolean
  - `EnableFeed` boolean
  - `AdminCanExportMembers` boolean
  - `PhotoApproval` boolean
  - `EmailOptionsAdmin` integer
  - `EmailOptionsMember` integer
  - `ShortDescription` string
  - `WelcomeContent` string
  - `UsingRedis` boolean
  - `AppInitTime` string, date-time
  - `ServerID` string
  - `ClientID` integer
  - `ResponseStatus` ResponseStatus: ResponseStatus
    - `ErrorCode` string
    - `Message` string
    - `StackTrace` string
    - `Errors` ResponseError[]
      - `ErrorCode` string
      - `FieldName` string
      - `Message` string
      - `Meta` DictionaryStringString: Dictionary<String,String>
    - `Meta` DictionaryStringString: Dictionary<String,String>
  - `BypassCache` boolean
  - `DateCached` string, date-time
  - `Device` string

---

[API](https://skmtc.dev/yourmembership/apis/ym-rest-services.md) - [All operations](https://skmtc.dev/yourmembership/apis/ym-rest-services/llms.txt) - [OpenAPI document](https://skmtc.dev/yourmembership/apis/ym-rest-services/revisions/8d8a2e7e7d56?raw)