---
title: "Return a list of members based on term."
method: GET
path: "/Ams/{ClientID}/Member/{MemberID}/DirectorySearch"
tags: ["Ams"]
---

# Return a list of members based on term.

`GET /Ams/{ClientID}/Member/{MemberID}/DirectorySearch`

## Request

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

Return a list of members based on term.

## Path parameters

- `MemberID` integer, required
- `ClientID` integer, required

## Query parameters

- `Term` string
- `PageSize` integer
- `StartIndex` integer
- `IncludeNonMembers` boolean
- `ResponseStatus` string
- `BypassCache` boolean
- `DateCached` string, date-time
- `Device` string

## Response `200`

Success

- DirectorySearchResponse: DirectorySearchResponse
  - `ResultCount` integer
  - `DirectorySearchProfileList` DirectorySearchProfile[]
    - `CanHaveConnections` boolean
    - `CanUseMessaging` boolean
    - `MemberID` integer
    - `PrimaryGroupName` string
    - `IsMember` boolean
    - `IsNonMember` boolean
    - `Name` string
    - `City` string
    - `Location` string
    - `AddressLine1` string
    - `AddressLine2` string
    - `Phone` string
    - `HeadshotImagePath` string
    - `NonMemberLost` boolean
    - `NonMemberDeceased` boolean
    - `NonMemberComments` string
    - `JobTitle` string
  - `Term` string
  - `PageSize` integer
  - `StartIndex` integer
  - `IncludeNonMembers` boolean
  - `MemberID` integer
  - `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)