# Information

Retrieve member details including contact and membership information.

Endpoint: GET /members
Version: 1.1
Security: OAuth2, ApiKeyAuth

## Query parameters:

  - `fromdate` (string)
    Filter members by their membership start date.

  - `updatedate` (string)
    Filter members by their last update date.

  - `status` (string)
    Filter by current member status.

  - `offset` (integer)
    The index of the first result to return. Use with limit to get the next page of search results.

  - `limit` (integer)
    The maximum number of results to return.

## Response 200 fields (application/json):

  - `href` (string)
    Current API URL
    Example: https://api.clubfit.net.au/v1/members

  - `next` (string)
    Next API URL to retrieve the next page
    Example: https://api.clubfit.net.au/v1/members?limit=500&offset=500

  - `data` (array)

  - `data.Number` (string)
    Example: 1000

  - `data.FirstName` (string)
    Example: John

  - `data.LastName` (string)
    Example: Doe

  - `data.Status` (string)
    Example: Active

  - `data.Barcode` (string)
    Example: 51234

  - `data.FitnessPassportNumber` (string)
    Example: 51234

  - `data.DateOfBirth` (string)
    ISO 8601 date and time with no UTC offset, e.g. 2024-08-24T14:30:00. Clients must not send an offset or trailing Z.
    Example: 2000-01-01T00:00:00

  - `data.Gender` (string)
    Example: M

  - `data.LastUpdatedUtcDateTime` (string)
    This date time is in UTC. ISO 8601 date and time with no UTC offset, e.g. 2024-08-24T14:30:00. Clients must not send an offset or trailing Z.
    Example: 2000-01-01T00:00:00

  - `data.Contact` (object)

  - `data.Contact.Email` (string, required)
    Example: john@doe.com

  - `data.Contact.OptOutEmail` (boolean)
    true the contact has opted out to email communication
    Example: false

  - `data.Contact.Mobile` (string)
    Example: 0424000000

  - `data.Contact.OptOutSms` (boolean)
    true the contact has opted out to sms communication
    Example: false

  - `data.Contact.Home` (string)
    Example: 0712345661

  - `data.Contact.Work` (string)
    Example: 074555667

  - `data.Contact.Address` (string)
    Example: 1 No way Street

  - `data.Contact.Suburb` (string)
    Example: Sunnyhills

  - `data.Contact.State` (string)
    Example: QLD

  - `data.Contact.Postcode` (string)
    Example: 4000

  - `data.Membership` (object)

  - `data.Membership.Id` (integer, required)
    Example: 12345

  - `data.Membership.Name` (string, required)
    Example: 12 Month Membership

  - `data.Membership.StartDate` (string, required)
    Gym local time. ISO 8601 date and time with no UTC offset, e.g. 2024-08-24T14:30:00. Clients must not send an offset or trailing Z.
    Example: 2024-08-24T00:00:00

  - `data.Membership.SaleDate` (string)
    Gym local time. ISO 8601 date and time with no UTC offset, e.g. 2024-08-24T14:30:00. Clients must not send an offset or trailing Z.
    Example: 2024-08-24T00:00:00

  - `data.Membership.CancellationDate` (string)
    Displays if there is a value. ISO 8601 date and time with no UTC offset, e.g. 2024-08-24T14:30:00. Clients must not send an offset or trailing Z.
    Example: 2024-08-24T00:00:00

  - `data.Membership.MinimumTermDate` (string)
    Displays if there is a value. ISO 8601 date and time with no UTC offset, e.g. 2024-08-24T14:30:00. Clients must not send an offset or trailing Z.
    Example: 2024-08-24T00:00:00

  - `data.Membership.ExpiryDate` (string)
    Displays if membership contract type is Paid in Full. ISO 8601 date and time with no UTC offset, e.g. 2024-08-24T14:30:00. Clients must not send an offset or trailing Z.
    Example: 2024-08-24T00:00:00

  - `data.Membership.Type` (string, required)
    Example: Direct Debit