---
title: "Returns a list of Members, based on GroupCode"
method: GET
path: "/Ams/{ClientID}/MemberList"
tags: ["Ams"]
---

# Returns a list of Members, based on GroupCode

`GET /Ams/{ClientID}/MemberList`

## Request

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

Required parameters are PageSize, PageNumber. FieldSelection is a string that accepts a combination of member's response fields seperated by comma.

## Path parameters

- `ClientID` integer, required

## Query parameters

- `GroupCode` string
- `PageSize` integer
- `PageNumber` integer
- `FieldSelection` string
- `UsingRedis` boolean
- `AppInitTime` string, date-time
- `ServerID` string
- `ResponseStatus` string
- `BypassCache` boolean
- `DateCached` string, date-time
- `Device` string

## Response `200`

Success

- MemberListResponse: MemberListResponse
  - `Members` MemberResponse[]
    - `ProfileID` integer
    - `IsMember` boolean
    - `ImportID` string
    - `Approved` boolean
    - `Suspended` boolean
    - `MasterID` string
    - `ApprovalDate` string, date-time
    - `QueuedForDelete` boolean
    - `QueuedForDeleteDate` string, date-time
    - `MembershipEffectiveExpiresDate` string, date-time
    - `EmailBounced` boolean
    - `HasConsented` boolean
    - `DateConsented` string, date-time
    - `ConsentIPAddress` string
    - `HasRevokedConsent` boolean
    - `DateConsentRevoked` string, date-time
    - `MasterProfileID` string: This key replaces the “MasterID” key.
    - `UserName` string
    - `MembershipExpires` boolean
    - `MembershipExpiresDate` string, date-time
    - `SubordinateSeats` integer
    - `ConstituentID` string
    - `MemberTypeCode` string
    - `Registered` string, date-time
    - `Membership` string
    - `LastRenewalDate` string, date-time
    - `LastRenewalReminderSent` string, date-time
    - `PrimaryGroupCode` string
    - `LastUpdated` string, date-time
    - `Gender` string
    - `Prefix` string
    - `FirstName` string
    - `MiddleName` string
    - `LastName` string
    - `Suffix` string
    - `NickName` string
    - `MaidenName` string
    - `SpouseName` string
    - `MaritalStatus` string
    - `AnniversaryDate` string, date-time
    - `BirthdayDate` string, date-time
    - `HomeUrl` string
    - `HomeAddressLine1` string
    - `HomeAddressLine2` string
    - `HomeAddressCity` string
    - `HomeAddressLocation` string
    - `HomeAddressPostalCode` string
    - `HomeAddressCountry` string
    - `HomePhoneCountryCode` string
    - `HomePhoneAreaCode` string
    - `HomePhoneNumber` string
    - `HomeFaxNumber` string
    - `HomeFaxCountryCode` string
    - `HomeFaxAreaCode` string
    - `Email` string
    - `EmailAlt` string
    - `HeadshotImageURI` string
    - `EmployerName` string
    - `SelfEmployed` boolean
    - `WorkTitle` string
    - `WorkType` string
    - `WorkUrl` string
    - `WorkAddressLine1` string
    - `WorkAddressLine2` string
    - `WorkAddressCity` string
    - `WorkAddressLocation` string
    - `WorkAddressPostalCode` string
    - `WorkAddressCountry` string
    - `WorkPhoneCountryCode` string
    - `WorkPhoneNumber` string
    - `WorkPhoneAreaCode` string
    - `WorkFaxNumber` string
    - `WorkFaxAreaCode` string
    - `PersonalComments` string
    - `AdditionalEdu` string
    - `SocialOrgs` string
    - `PreferredAddressLatitude` number, double
    - `PreferredAddressLongitude` number, double
    - `MemberCustomFieldResponses` CustomFieldResponses: CustomFieldResponses
      - `ClientID` integer
      - `CustomFieldList` CustomField[]
        - `ClientID` integer
        - `FieldType` string
        - `GroupCode` string
        - `GroupCodeFriendly` string
        - `Required` boolean
        - `Visible` integer
        - `MemberCanOverride` boolean
        - `Editable` integer
        - `Searchable` boolean
        - `Ordinal` integer
        - `MaxLength` integer
        - `IsMultiSelect` boolean
        - `IsFIB` boolean
        - `IsFileUpload` boolean
        - `Label` string
        - `Code` string
        - `ExportLabel` string
        - `SearchLabel` string
        - `SearchInfo` string
        - `Description` string
        - `ValidationExpression` string
        - `MemberTypes` CustomFieldMemberType[]
          - `MemberTypeID` string
        - `DuringRegistrationVisible` CustomFieldMemberType[]
          - `MemberTypeID` string
        - `DuringRegistrationRequired` CustomFieldMemberType[]
          - `MemberTypeID` string
        - `AfterRegistrationVisible` CustomFieldMemberType[]
          - `MemberTypeID` string
        - `AfterRegistrationRequired` CustomFieldMemberType[]
          - `MemberTypeID` string
        - `DonationFunds` CustomFieldDonationFund[]
          - `DonationFundID` string
        - `MemberTypesProxy` ArrayList: ArrayList
        - `Values` CustomFieldValue[]
          - `Ordinal` integer
          - `Text` string
          - `Value` string
        - `ValuesProxy` ArrayList: ArrayList
        - `HelpTopic` CustomHelp: CustomHelp
          - `ID` integer
          - `ClientID` integer
          - `Label` string
          - `Content` string
          - `Width` integer
          - `Height` integer
        - `FieldDataType` string
      - `UploadedFilesCleanupList` CustomFieldResponse[]
        - `FieldCode` string
        - `Fields` CustomFields: CustomFields
          - `ClientID` integer
          - `Capacity` integer
          - `Count` integer
          - `Item` CustomField: CustomField
            - `ClientID` integer
            - `FieldType` string
            - `GroupCode` string
            - `GroupCodeFriendly` string
            - `Required` boolean
            - `Visible` integer
            - `MemberCanOverride` boolean
            - `Editable` integer
            - `Searchable` boolean
            - `Ordinal` integer
            - `MaxLength` integer
            - `IsMultiSelect` boolean
            - `IsFIB` boolean
            - `IsFileUpload` boolean
            - `Label` string
            - `Code` string
            - `ExportLabel` string
            - `SearchLabel` string
            - `SearchInfo` string
            - `Description` string
            - `ValidationExpression` string
            - `MemberTypes` CustomFieldMemberType[]
              - …
            - `DuringRegistrationVisible` CustomFieldMemberType[]
              - …
            - `DuringRegistrationRequired` CustomFieldMemberType[]
              - …
            - `AfterRegistrationVisible` CustomFieldMemberType[]
              - …
            - `AfterRegistrationRequired` CustomFieldMemberType[]
              - …
            - `DonationFunds` CustomFieldDonationFund[]
              - …
            - `MemberTypesProxy` ArrayList: ArrayList
            - `Values` CustomFieldValue[]
              - …
            - `ValuesProxy` ArrayList: ArrayList
            - `HelpTopic` CustomHelp: CustomHelp
              - …
            - `FieldDataType` string
        - `Visibility` string
        - `VisibilityInt` integer
        - `Values` CustomFieldResponseValue[]
          - `Value` string
          - `Text` string
        - `ValuesProxy` ArrayList: ArrayList
        - `MetaValue` CustomFieldResponseValue: CustomFieldResponseValue
          - `Value` string
          - `Text` string
        - `ClientID` integer
      - `Capacity` integer
      - `Count` integer
      - `Item` CustomFieldResponse: CustomFieldResponse
        - `FieldCode` string
        - `Fields` CustomFields: CustomFields
          - `ClientID` integer
          - `Capacity` integer
          - `Count` integer
          - `Item` CustomField: CustomField
            - `ClientID` integer
            - `FieldType` string
            - `GroupCode` string
            - `GroupCodeFriendly` string
            - `Required` boolean
            - `Visible` integer
            - `MemberCanOverride` boolean
            - `Editable` integer
            - `Searchable` boolean
            - `Ordinal` integer
            - `MaxLength` integer
            - `IsMultiSelect` boolean
            - `IsFIB` boolean
            - `IsFileUpload` boolean
            - `Label` string
            - `Code` string
            - `ExportLabel` string
            - `SearchLabel` string
            - `SearchInfo` string
            - `Description` string
            - `ValidationExpression` string
            - `MemberTypes` CustomFieldMemberType[]
              - …
            - `DuringRegistrationVisible` CustomFieldMemberType[]
              - …
            - `DuringRegistrationRequired` CustomFieldMemberType[]
              - …
            - `AfterRegistrationVisible` CustomFieldMemberType[]
              - …
            - `AfterRegistrationRequired` CustomFieldMemberType[]
              - …
            - `DonationFunds` CustomFieldDonationFund[]
              - …
            - `MemberTypesProxy` ArrayList: ArrayList
            - `Values` CustomFieldValue[]
              - …
            - `ValuesProxy` ArrayList: ArrayList
            - `HelpTopic` CustomHelp: CustomHelp
              - …
            - `FieldDataType` string
        - `Visibility` string
        - `VisibilityInt` integer
        - `Values` CustomFieldResponseValue[]
          - `Value` string
          - `Text` string
        - `ValuesProxy` ArrayList: ArrayList
        - `MetaValue` CustomFieldResponseValue: CustomFieldResponseValue
          - `Value` string
          - `Text` string
        - `ClientID` integer
  - `TotalMemberFound` 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)