--- title: "Retrieve a Collection of Members" method: GET path: "/wolfconnect/members/v1" tags: ["Members"] --- # Retrieve a Collection of Members `GET /wolfconnect/members/v1` ## Request - Base URL: `https://api.globalwolfweb.com` - URL: `https://api.globalwolfweb.com/wolfconnect/members/v1` - Auth: API key in header `Authorization` 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 ## Query parameters - `$expand` string - `$filter` string - `$orderby` string - `$skip` integer - `$top` integer ## Response `200` A collection of Member objects. - Member[] - `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, required: The first name of the member. - `MiddleName` string: The middle name of the member. - `LastName` string, required: 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, nullable: 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` Office - `Id` string: The Lone Wolf Id of the office. - `Name` string: The name. - `LWCompanyCode` string: The Lone Wolf Company Code. This is the code used by a brokerWOLF installation. It will be blank for offices that are not synced with brokerWOLF. - `MLSBoards` MLSBoard[]: A collection of the MLS boards to which the member belongs. - `MLSId` string: The MLS Id of the member for the MLS Board specified by the MLSAreaId. - `MLSAreaId` string: The Lone Wolf Id of the MLS area. - `Addresses` Address[], required: The collection of addresses for the member. Currently supported address types: M: Mailing, P: Physical - `City` string, required: The city. - `Confidential` boolean: True if the address is confidential. - `Country` string: The name of the country. This field is read only. - `CountryCode` string, required: The two digit ISO code for the country. - `Line1` string, required: The first line for the address. - `Line2` string: The second line for the address. - `Line3` string: The third line for the address. - `Line4` string: The fourth line for the address. - `PostalCode` string, required: The unformatted postal or zip code. - `Province` string: The name of the province or state. This field is read only. - `ProvinceCode` string, required: The province code or postal abbreviation of the province or state. - `Type` string: The name of the type of address. This field is read only. - `TypeCode` string, required: The code for the type of address. P: Physical, M: Mailing, H: Home, B: Business, W: Work, O: Other - `EmailAddresses` EmailAddress[]: The collection of email addresses for the member. Currently supported email address types: B: Business, S: Secondary - `Address` string, required: The email address. - `Confidential` boolean: True if the email address is confidential. - `Primary` boolean: True if this is the primary email address. - `Type` string: The name of the type of email address. - `TypeCode` string, required: The code for the type of email address. H: Home, B: Business, W: Work, S: Secondary, O: Other - `PhoneNumbers` PhoneNumber[]: The collection of phone numbers for the member. - `Confidential` boolean: True if the phone number is confidential. - `Extension` string: The extension for the phone number. - `Number` string, required: The unformatted phone number. - `Primary` boolean: True if this is the primary phone number. - `Type` string: The name of the type of phone number. - `TypeCode` string, required: The code for the type of phone number. A: Assistant, B: Business, BF: Business Fax, CB: Callback, C: Company, X: Extension, H: Home, HF: Home Fax, ISDN: ISDN, M: Mobile, P: Pager, R: Radio, T: Telex, TF: Toll Free, TTY: TTY/TDD, O: Other, OF: Other Fax - `Websites` Website[]: The collection of websites for the member. - `Type` string: The name of the type of website. - `TypeCode` string, required: The code for the type of website. B: Blog, C: Community, FB: Facebook, G: General, L: Linkedin, S: Sports, T: Tourism, TW: Twitter, YT: YouTube - `Url` string, required: The url of the website. - `PublicProfiles` PublicProfile[]: The collection of public profiles for 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. - `Name` string: The name of the public profile. - `FirstName` string: The first name of the member. - `MiddleName` string: The middle name of the member. - `LastName` string: The last name of the member. - `Title` string: The title of the member. - `Addresses` Address[]: The collection of addresses for the member. Currently supported address types: M: Mailing, P: Physical - `City` string, required: The city. - `Confidential` boolean: True if the address is confidential. - `Country` string: The name of the country. This field is read only. - `CountryCode` string, required: The two digit ISO code for the country. - `Line1` string, required: The first line for the address. - `Line2` string: The second line for the address. - `Line3` string: The third line for the address. - `Line4` string: The fourth line for the address. - `PostalCode` string, required: The unformatted postal or zip code. - `Province` string: The name of the province or state. This field is read only. - `ProvinceCode` string, required: The province code or postal abbreviation of the province or state. - `Type` string: The name of the type of address. This field is read only. - `TypeCode` string, required: The code for the type of address. P: Physical, M: Mailing, H: Home, B: Business, W: Work, O: Other - `EmailAddresses` EmailAddress[]: The collection of email addresses for the member. Currently supported email address types: B: Business, S: Secondary - `Address` string, required: The email address. - `Confidential` boolean: True if the email address is confidential. - `Primary` boolean: True if this is the primary email address. - `Type` string: The name of the type of email address. - `TypeCode` string, required: The code for the type of email address. H: Home, B: Business, W: Work, S: Secondary, O: Other - `PhoneNumbers` PhoneNumber[]: The collection of phone numbers for the member. - `Confidential` boolean: True if the phone number is confidential. - `Extension` string: The extension for the phone number. - `Number` string, required: The unformatted phone number. - `Primary` boolean: True if this is the primary phone number. - `Type` string: The name of the type of phone number. - `TypeCode` string, required: The code for the type of phone number. A: Assistant, B: Business, BF: Business Fax, CB: Callback, C: Company, X: Extension, H: Home, HF: Home Fax, ISDN: ISDN, M: Mobile, P: Pager, R: Radio, T: Telex, TF: Toll Free, TTY: TTY/TDD, O: Other, OF: Other Fax - `Websites` Website[]: The collection of websites for the member. - `Type` string: The name of the type of website. - `TypeCode` string, required: The code for the type of website. B: Blog, C: Community, FB: Facebook, G: General, L: Linkedin, S: Sports, T: Tourism, TW: Twitter, YT: YouTube - `Url` string, required: The url of the website. - `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` Integrations[]: The collection of partner integrations for the member. - `PartnerCode` string: The code for the Partner. Usually the Partner's name. - `Id` string: The Id for the Partner's matching Member. --- [API](https://skmtc.dev/lwolf/apis/wolfconnect-api.md) · [All operations](https://skmtc.dev/lwolf/apis/wolfconnect-api/llms.txt) · [OpenAPI document](https://skmtc.dev/lwolf/apis/wolfconnect-api/revisions/ef84b978ad6f?raw)