| Requires any of the roles: | admin, oauthadmin, member, oauthmember |
| GET | /Ams/{ClientID}/GroupTypes | Return a list of all group types. | |
|---|---|---|---|
| GET | /Ams/{ClientID}/Member/{MemberID}/GroupTypes | Return a list of group types for a member. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Status | query | Status | No | Allowable Values
|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| MemberID | form | int | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ClientID | form | int | No | |
| ResponseStatus | form | ResponseStatus | No | |
| BypassCache | form | bool | No | |
| DateCached | form | DateTime | No | |
| Device | form | Device | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| GroupTypeList | form | List<GroupType> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | int | No | |
| TypeName | form | string | No | |
| SortIndex | form | double? | No | |
| Groups | form | List<Group> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | int | No | |
| Name | form | string | No | |
| Status | form | Status? | No | |
| JoinOption | form | JoinOption? | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /Ams/{ClientID}/GroupTypes HTTP/1.1
Host: ws.yourmembership.com
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"GroupTypeList":[{"Id":0,"TypeName":"String","SortIndex":0,"Groups":[{"Id":0,"Name":"String","Status":"None","JoinOption":"CanJoin"}]}],"Status":"None","MemberID":0,"ClientID":0,"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"BypassCache":false,"DateCached":"2025-11-16T04:32:44.1677773-05:00","Device":"Desktop"}