Members

Retrieve a Collection of Members

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

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

Query parameters

$expandstring

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.

$filterstring

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

$orderbystring

Orders the objects returned in the response by a property related to the resource.

$skipinteger

Skips the specified number of records before returning the results. $orderby must be specified for $skip to be used.

$topinteger

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.

Response

A collection of Member objects.

Idstring

The Lone Wolf Id of the member.

CreatedTimestampstring date-time

The date and time the member was created.

ModifiedTimestampstring date-time

The date and time the member was modified.

MemberChangedTimestampstring date-time

The date and time the member or any associated record of the member was modified.

FirstNamestring required

The first name of the member.

MiddleNamestring

The middle name of the member.

LastNamestring required

The last name of the member.

Numberstring

The number assigned to the member by its office.

Titlestring

The title of the member.

BirthDatestring date

The birth date of the member.

InactiveDatestring date nullable

The date the member went inactive. (Nullable)

OfficeIdstring

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

MemberTypeIdstring

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

Suffixstring

Suffix of the member.

Nicknamestring

The Nickname of the member.

LegalNamestring

Legal Name of the member.

Usernamestring

The username of the member.

LoadingDocsUsernamestring

The loadingDOCS username of the member.

GenderCodestring

The Gender of the member.

AnniversaryDatestring date

The Date of their Anniversary.

StartDatestring date

The Start Date of the member.

CommencementDatestring date

The Commencement Date of the member.

MovingWolfEnabledboolean

The movingWOLF subscription status of the member.

Changes

No recorded changes to this operation across all 1 revision of this API.