Member getAll API Reference Guide

Overview

The Member getAll API allows you to query and retrieve detailed member information, including optional related data such as products, dependents, beneficiaries, and transactions. This API offers extensive filtering options to narrow your search based on a wide range of criteria.

Authentication

All requests require authentication. Basic Authentication headers or API key must be provided with each request.

Endpoint

Method	Endpoint	Description
`GET`	`/api/member/getall`	Retrieve member information based on specified criteria

Basic Query Parameters

Parameter	Type	Description	Example
`memberid`	String	Comma-separated list of member IDs	`12345,67890`
`brokerid`	Number	Broker ID	`123`
`show_tree`	Number	Set to `1` to include broker's downline	`1`
`user_status`	String	Filter by member status	`active`
`enrollerid`	Number	Filter by enroller ID	`456`

Member Information Parameters

Parameter	Type	Description	Example
`user_username`	String	Filter by username	`jsmith`
`user_firstname`	String	Filter by first name	`John`
`user_firstname_blank`	Number	Set to `1` to find blank first names	`1`
`user_lastname`	String	Filter by last name	`Smith`
`user_lastname_blank`	Number	Set to `1` to find blank last names	`1`
`user_company`	String	Filter by company name	`ABC Corp`
`user_city`	String	Filter by city	`Phoenix`
`user_state`	String	Filter by state code	`AZ`
`user_email`	String	Filter by email address	`example@domain.com`
`user_phone1`	String	Filter by primary phone	`5551234567`
`user_phone2`	String	Filter by secondary phone	`5559876543`
`user_phone3`	String	Filter by tertiary phone	`5551112222`
`user_gender`	String	Filter by gender	`M`
`user_position`	String	Filter by position	`Manager`
`ssn_blank`	Number	Set to `1` to find blank SSNs	`1`

Date-Based Parameters

All date parameters accept standard date formats or special keywords: today, tomorrow, yesterday, lastweek, nextweek, thisweek, lastmonth, nextmonth, thismonth, lastyear, nextyear, thisyear, lastXdays, nextXdays (where X is a number).

Parameter	Type	Description	Example
`user_created_from`	Date	Filter by creation date (from)	`2023-01-01`
`user_created_to`	Date	Filter by creation date (to)	`2023-12-31`
`user_created_blank`	Number	Set to `1` to find blank creation dates	`1`
`user_changed_from`	Date	Filter by last modified date	`2023-06-01`
`user_dob_from`	Date	Filter by date of birth (from)	`1980-01-01`
`user_dob_to`	Date	Filter by date of birth (to)	`2000-12-31`
`user_dob_blank`	Number	Set to `1` to find blank DOBs	`1`
`user_dob_month`	Number	Filter by birth month (1-12)	`6`
`user_dob_day`	Number	Filter by birth day (1-31)	`15`
`user_dob_year`	Number	Filter by birth year (4-digit)	`1985`
`user_dob_options`	String	Set to `blank` or `invalid`	`blank`

Age-Based Parameters

Parameter	Type	Description	Example
`user_age_from`	Number	Filter by age (from)	`25`
`user_age_to`	Number	Filter by age (to)	`45`

Product Parameters

Parameter	Type	Description	Example
`product`	String	Filter by product name/ID	`health-plan`
`product_not`	Number	Set to `1` to exclude specified product	`1`
`product_category`	String	Filter by product category	`insurance`
`product_search_type`	String	Filter by product search type	`basic`
`product_status`	String	Filter by product status	`active`
`policynumber`	String	Filter by policy number	`POL123456`
`product_paid`	Number	Set to `1` for paid products, `0` for unpaid	`1`
`product_onhold`	Number	Set to `1` for products on hold	`1`
`product_suspended`	Number	Set to `1` for suspended products	`1`
`product_cancel_reason`	String	Filter by cancellation reason	`non-payment`
`product_effective_day`	Number	Filter by effective day of month (1-31)	`15`
`product_recurring_day`	Number	Filter by recurring billing day (1-31)	`1`

Product Date Parameters

Parameter	Type	Description	Example
`product_created_from`	Date	Filter by product creation date (from)	`2023-01-01`
`product_created_to`	Date	Filter by product creation date (to)	`2023-12-31`
`product_fulfillment_from`	Date	Filter by fulfillment date (from)	`2023-01-15`
`product_fulfillment_to`	Date	Filter by fulfillment date (to)	`2023-12-15`
`product_billing_from`	Date	Filter by billing date (from)	`2023-02-01`
`product_billing_to`	Date	Filter by billing date (to)	`2023-11-30`
`product_effective_from`	Date	Filter by effective date (from)	`2023-03-01`
`product_effective_to`	Date	Filter by effective date (to)	`2023-10-31`
`product_cancel_from`	Date	Filter by cancellation date (from)	`2023-09-01`
`product_cancel_to`	Date	Filter by cancellation date (to)	`2023-12-31`
`product_cancel_set_from`	Date	Filter by cancellation set date (from)	`2023-08-15`
`product_cancel_set_to`	Date	Filter by cancellation set date (to)	`2023-12-15`
`product_renewal_from`	Date	Filter by renewal date (from)	`2024-01-01`
`product_renewal_to`	Date	Filter by renewal date (to)	`2024-12-31`

Payment Parameters

Parameter	Type	Description	Example
`payment_number_from`	Number	Filter by payment number (from)	`1`
`payment_number_to`	Number	Filter by payment number (to)	`12`
`payment_firstname`	String	Filter by payment first name	`John`
`payment_lastname`	String	Filter by payment last name	`Smith`
`payment_amount_from`	Number	Filter by payment amount (from)	`50.00`
`payment_amount_to`	Number	Filter by payment amount (to)	`500.00`
`payment_ach_number`	String	Filter by ACH number	`12345`
`payment_cc_type`	String	Filter by credit card type	`VISA`
`payment_cc_last4`	Number	Filter by last 4 digits of card	`1234`
`payment_cc_expm`	Number	Filter by card expiration month (1-12)	`6`
`payment_cc_expy`	Number	Filter by card expiration year (4-digit)	`2025`
`payment_type`	String	Filter by payment type	`CC`
`payment_type_default`	String	Filter by default payment type	`ACH`
`user_invoiced`	Number	Set to `1` for invoiced, `0` for not invoiced	`1`
`payment_period_id`	String	Filter by payment period ID	`monthly`
`user_payments_missed`	Number	Filter by number of missed payments	`2`

Lead Management Parameters

Parameter	Type	Description	Example
`user_is_lead`	Number	Set to `1` for leads, `0` for non-leads	`1`
`lead_status`	String	Filter by lead status	`new`
`lead_status_type`	String	Set to `not` to exclude specified status	`not`
`lead_sales_stage`	String	Filter by sales stage	`qualified`
`lead_numcalls`	Number	Filter by number of calls	`3`
`lead_call_status`	String	Filter by call status	`attempted`
`lead_ranking`	Number	Filter by lead ranking (0-100)	`75`

Dependent Parameters

Parameter	Type	Description	Example
`dependent_firstname`	String	Filter by dependent first name	`Jane`
`dependent_firstname_blank`	Number	Set to `1` for blank first names	`1`
`dependent_lastname`	String	Filter by dependent last name	`Smith`
`dependent_lastname_blank`	Number	Set to `1` for blank last names	`1`
`dependent_city`	String	Filter by dependent city	`Phoenix`
`dependent_state`	String	Filter by dependent state	`AZ`
`dependent_zipcode`	String	Filter by dependent ZIP code	`85001`
`dependent_email`	String	Filter by dependent email	`jane@example.com`
`dependent_phone1`	String	Filter by dependent primary phone	`5551234567`
`dependent_relationship`	String	Filter by relationship type	`spouse`
`dependent_relationship_blank`	Number	Set to `1` for blank relationships	`1`
`dependent_gender`	String	Filter by dependent gender	`F`
`dependent_age_from`	Number	Filter by dependent age (from)	`5`
`dependent_age_to`	Number	Filter by dependent age (to)	`18`

Response Fields Option Parameters

Parameter	Type	Description	Example
`return_products`	Number	Set to `1` to include product details	`1`
`return_dependents`	Number	Set to `1` to include dependent details	`1`
`return_beneficiaries`	Number	Set to `1` to include beneficiary details	`1`
`return_transactions`	Number	Set to `1` to include transaction details	`1`

Response Format

The API returns an XML response with the following structure:

<method request="user.getall">
  <users total="2">
    <user>
      <userid>12345</userid>
      <username>jdoe</username>
      <firstname>John</firstname>
      <lastname>Doe</lastname>
      <email>john.doe@example.com</email>
      <!-- Additional user fields -->
    </user>
    <user>
      <!-- Second user -->
    </user>
  </users>
  
  <!-- Optional sections based on return_* parameters -->
  <dependents total="3">
    <dependent>
      <!-- Dependent details -->
    </dependent>
    <!-- Additional dependents -->
  </dependents>
  
  <beneficiaries total="2">
    <beneficiary>
      <!-- Beneficiary details -->
    </beneficiary>
    <!-- Additional beneficiaries -->
  </beneficiaries>
  
  <products total="4">
    <product>
      <!-- Product details -->
      <productfees total="2">
        <!-- Fee details -->
      </productfees>
    </product>
    <!-- Additional products -->
  </products>
  
  <transactions total="6">
    <transaction>
      <!-- Transaction details -->
      <transactiondetails total="3">
        <!-- Transaction line items -->
      </transactiondetails>
      <transactionpayments total="1">
        <!-- Payment details -->
      </transactionpayments>
    </transaction>
    <!-- Additional transactions -->
  </transactions>
</method>

Error Responses

If the request fails validation or encounters an error, the API returns an error response:

<method request="user.getall">
  <errors>
    <error parameter="user_dob_month">Error: Value for parameter [user_dob_month] should be numeric value 1-12.</error>
    <!-- Additional errors if applicable -->
  </errors>
</method>

If no data matches the search criteria:

<method request="user.getall">
  <nodata>No data was found with your search</nodata>
</method>

Examples

Basic Member Search

GET /api/member/getall?user_lastname=Smith&user_state=AZ

Advanced Search with Multiple Parameters

GET /api/member/getall?brokerid=123&show_tree=1&user_created_from=lastmonth&product=health-insurance&return_products=1&return_dependents=1

Search by Date Range with Product Details

GET /api/member/getall?product_effective_from=2023-01-01&product_effective_to=2023-12-31&return_products=1

Search for Members with Missing Information

GET /api/member/getall?user_firstname_blank=1&ssn_blank=1

Overview​

Authentication​

Endpoint​

Basic Query Parameters​

Member Information Parameters​

Date-Based Parameters​

Age-Based Parameters​

Product Parameters​

Product Date Parameters​

Payment Parameters​

Lead Management Parameters​

Dependent Parameters​

Response Fields Option Parameters​

Response Format​

Error Responses​

Examples​

Basic Member Search​

Advanced Search with Multiple Parameters​

Search by Date Range with Product Details​

Search for Members with Missing Information​