# Retrieve a Collection of Members

**GET /wolfconnect/members/v1**

Retrieves a collection of members within the current client code. OData can be used to filter, order and page through the list.

**OData Support:** $expand, $filter, $orderby, $skip, $top


## Servers
- Production: https://api.globalwolfweb.com (Production)
- Test: https://api-sb.globalwolfweb.com (Test)


## Authentication methods
- Lone wolf token


## Parameters


### Query parameters

- **$expand** (string)
  Instructs the API to include a child object or collection in the response. If omitted, ALL child objects and collections are returned. Pass `$expand=` (empty) to return only the root object. See the OData Support section of the introduction.

- **$filter** (string)
  Filters data on properties related to the resource. Only Logical, Arithmetic and Grouping operators are currently supported. No Canonical functions are currently supported (contains, endswith, startswith, etc.).

- **$orderby** (string)
  Orders the objects returned in the response by a property related to the resource.

- **$skip** (integer)
  Skips the specified number of records before returning the results. $orderby must be specified for $skip to be used.

- **$top** (integer)
  Returns the specified top number of records for the given query. $orderby must be specified for $top to be used. The maximum number of objects returned from any resource is 1,000. If not passed, $top=1000 is assumed.



## Responses
### 200
A collection of Member objects.

#### Body: application/json (array[object])
- **Id** (string)
  The Lone Wolf Id of the member.

- **CreatedTimestamp** (string(date-time))
  The date and time the member was created.

- **ModifiedTimestamp** (string(date-time))
  The date and time the member was modified.

- **MemberChangedTimestamp** (string(date-time))
  The date and time the member or any associated record of the member was modified.

- **FirstName** (string)
  The first name of the member.

- **MiddleName** (string)
  The middle name of the member.

- **LastName** (string)
  The last name of the member.

- **Number** (string)
  The number assigned to the member by its office.

- **Title** (string)
  The title of the member.

- **BirthDate** (string(date))
  The birth date of the member.

- **InactiveDate** (string(date) | null)
  The date the member went inactive. (Nullable)

- **OfficeId** (string)
  The Lone Wolf Id of the office to which the member belongs. Required for creating only - it will be ignored when updating a member.

- **Office** (object)
  The office object.

- **MLSBoards** (array[object])
  A collection of the MLS boards to which the member belongs.

- **Addresses** (array[object])
  The collection of addresses for the member. Currently supported address types: M: Mailing, P: Physical

- **EmailAddresses** (array[object])
  The collection of email addresses for the member. Currently supported email address types: B: Business, S: Secondary

- **PhoneNumbers** (array[object])
  The collection of phone numbers for the member.

- **Websites** (array[object])
  The collection of websites for the member.

- **PublicProfiles** (array[object])
  The collection of public profiles for the member.

- **MemberTypeId** (string)
  The Type of member (eg. Agent, Staff). Required for creating only - it will be ignored when updating a member.

- **Suffix** (string)
  Suffix of the member.

- **Nickname** (string)
  The Nickname of the member.

- **LegalName** (string)
  Legal Name of the member.

- **Username** (string)
  The username of the member.

- **LoadingDocsUsername** (string)
  The loadingDOCS username of the member.

- **GenderCode** (string)
  The Gender of the member.

- **AnniversaryDate** (string(date))
  The Date of their Anniversary.

- **StartDate** (string(date))
  The Start Date of the member.

- **CommencementDate** (string(date))
  The Commencement Date of the member.

- **MovingWolfEnabled** (boolean)
  The movingWOLF subscription status of the member.

- **Integrations** (array[object])
  The collection of partner integrations for the member.



[Powered by Bump.sh](https://bump.sh)