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.

  Maximum value is 1000.

Responses

• 200 application/json

  A collection of Member objects.

  Hide response attributes Show response attributes object

  • Id string

    The Lone Wolf Id of the member.

    Maximum length is 50.

  • 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.

    Maximum length is 50.

  • MiddleName string

    The middle name of the member.

    Maximum length is 50.

  • LastName string Required

    The last name of the member.

    Maximum length is 50.

  • Number string

    The number assigned to the member by its office.

    Maximum length is 12.

  • Title string

    The title of the member.

    Maximum length is 100.

  • 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.

    Maximum length is 50.

  • Office object

    The office object.

    Hide Office attributes Show Office attributes object

    • 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 array[object]

    A collection of the MLS boards to which the member belongs.

    Hide MLSBoards attributes Show MLSBoards attributes object

    • 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 array[object] Required

    The collection of addresses for the member. Currently supported address types: M: Mailing, P: Physical

    Hide Addresses attributes Show Addresses attributes object

    • City string Required

      The city.

      Maximum length is 50.

    • 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.

      Maximum length is 2.

    • Line1 string Required

      The first line for the address.

      Maximum length is 200.

    • Line2 string

      The second line for the address.

      Maximum length is 200.

    • Line3 string

      The third line for the address.

      Maximum length is 200.

    • Line4 string

      The fourth line for the address.

      Maximum length is 200.

    • PostalCode string Required

      The unformatted postal or zip code.

      Maximum length is 20.

    • 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.

      Maximum length is 20.

    • 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

      Maximum length is 1.

  • EmailAddresses array[object]

    The collection of email addresses for the member. Currently supported email address types: B: Business, S: Secondary

    Hide EmailAddresses attributes Show EmailAddresses attributes object

    • Address string Required

      The email address.

      Maximum length is 100.

    • 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

      Maximum length is 1.

  • PhoneNumbers array[object]

    The collection of phone numbers for the member.

    Hide PhoneNumbers attributes Show PhoneNumbers attributes object

    • Confidential boolean

      True if the phone number is confidential.

    • Extension string

      The extension for the phone number.

      Maximum length is 5.

    • Number string Required

      The unformatted phone number.

      Maximum length is 20.

    • 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

      Maximum length is 1.

  • Websites array[object]

    The collection of websites for the member.

    Hide Websites attributes Show Websites attributes object

    • 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

      Maximum length is 1.

    • Url string Required

      The url of the website.

      Maximum length is 100.

  • PublicProfiles array[object]

    The collection of public profiles for the member.

    Hide PublicProfiles attributes Show PublicProfiles attributes object

    • 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.

      Maximum length is 50.

    • FirstName string

      The first name of the member.

      Maximum length is 50.

    • MiddleName string

      The middle name of the member.

      Maximum length is 50.

    • LastName string

      The last name of the member.

      Maximum length is 50.

    • Title string

      The title of the member.

      Maximum length is 100.

    • Addresses array[object]

      The collection of addresses for the member. Currently supported address types: M: Mailing, P: Physical

      Hide Addresses attributes Show Addresses attributes object

      • City string Required

        The city.

        Maximum length is 50.

      • 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.

        Maximum length is 2.

      • Line1 string Required

        The first line for the address.

        Maximum length is 200.

      • Line2 string

        The second line for the address.

        Maximum length is 200.

      • Line3 string

        The third line for the address.

        Maximum length is 200.

      • Line4 string

        The fourth line for the address.

        Maximum length is 200.

      • PostalCode string Required

        The unformatted postal or zip code.

        Maximum length is 20.

      • 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.

        Maximum length is 20.

      • 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

        Maximum length is 1.

    • EmailAddresses array[object]

      The collection of email addresses for the member. Currently supported email address types: B: Business, S: Secondary

      Hide EmailAddresses attributes Show EmailAddresses attributes object

      • Address string Required

        The email address.

        Maximum length is 100.

      • 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

        Maximum length is 1.

    • PhoneNumbers array[object]

      The collection of phone numbers for the member.

      Hide PhoneNumbers attributes Show PhoneNumbers attributes object

      • Confidential boolean

        True if the phone number is confidential.

      • Extension string

        The extension for the phone number.

        Maximum length is 5.

      • Number string Required

        The unformatted phone number.

        Maximum length is 20.

      • 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

        Maximum length is 1.

    • Websites array[object]

      The collection of websites for the member.

      Hide Websites attributes Show Websites attributes object

      • 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

        Maximum length is 1.

      • Url string Required

        The url of the website.

        Maximum length is 100.

  • 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.

    Hide Integrations attributes Show Integrations attributes object

    • PartnerCode string

      The code for the Partner. Usually the Partner's name.

      Maximum length is 100.

    • Id string

      The Id for the Partner's matching Member.

      Maximum length is 100.