---
title: "Returns a person's group relationship data."
method: GET
path: "/Ams/{ClientID}/PeopleGroups"
tags: ["Ams"]
---

# Returns a person's group relationship data.

`GET /Ams/{ClientID}/PeopleGroups`

## Request

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

There are three types of relationships that members may have with particular groups; 'Administrator', 'Member' and 'Representative'. Groups are listed within nodes respective of their relationship type.

## Path parameters

- `ClientID` integer, required

## Query parameters

- `ID` integer
- `UsingRedis` boolean
- `AppInitTime` string, date-time
- `ServerID` string
- `ResponseStatus` string
- `BypassCache` boolean
- `DateCached` string, date-time
- `Device` string

## Response `200`

Success

- PeopleGroupsResponse: PeopleGroupsResponse
  - `Relationships` Relationship[]
    - `RelationshipTag` string
    - `Groups` PeopleGroup[]
      - `GroupID` integer
      - `Code` string
      - `Name` string
      - `Title` string
      - `Primary` boolean
  - `ID` integer
  - `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)