GET api/members

Get a list of members ordered by create date. The list can be filtered by program. The offset and count parameters can be used to specify the set of members.

Request Information

URI Parameters

Query String: programId={programId}&query={query}&showDisabled={showDisabled}&sort={sort}&dateFrom={dateFrom}&dateTo={dateTo}&offset={offset}&count={count}

NameDescriptionTypeAdditional information
programId

ID of the program, program name, or program title. Optional.

string

None.

query

If specified, a member must have this value as its email address, id, external id, referral code. Optional.

string

None.

showDisabled

Set True to display disabled member. Set False to Show Active Members. Optional.

boolean

None.

sort

Column to sort by. Accepted values: Member_Views_Desc, Member_Views_Asc, Page_Views_Desc, Page_Views_Asc, Lead_Count_Desc, Lead_Count_Asc, Reward_Issued_Total_Desc, Reward_Issued_Total_Asc, Member_Full_Name_Desc, Member_Full_Name_Asc, Create_Dt_Desc , Create_Dt_Asc . Optional.

string

Default value is Create_Dt_Desc

dateFrom

Show all members created after this date. Optional.

date

None.

dateTo

Show all members created before this date. Optional.

date

None.

offset

Starting index (0 based) of the members. Optional.

integer

Default value is 0

count

Count of members returned. Optional.

integer

Default value is 2147483647

Body Parameters

None.

Response Information

Resource Description

[HTTP Status 200 - OK] A set of members.

Type: MemberSet

NameDescriptionTypeAdditional information
members

Collection of Member

None.

offset

Starting index (0 based) of the elements in the set.

integer

None.

total

Total number of elements in the set.

integer

None.

message

The message provides more information about the results of the client's request. Review this field for error information.

string

None.

Response Formats

application/json, text/json

Sample:
{
  "offset": 1,
  "total": 2,
  "message": "sample string 3",
  "members": [
    {
      "id": "1eb7bb6b-1c4d-429d-ba73-7314590b7fd5",
      "displayName": "sample string 2",
      "firstName": "sample string 3",
      "lastName": "sample string 4",
      "email": "sample string 5",
      "phone": "sample string 6",
      "externalIdentifier": "sample string 7",
      "dateOfBirth": "2018-07-19T13:22:35.8237267Z",
      "addressLine1": "sample string 8",
      "addressLine2": "sample string 9",
      "city": "sample string 10",
      "countrySubdivision": "sample string 11",
      "country": "sample string 12",
      "postalCode": "sample string 13",
      "disabledFlag": true,
      "customOverrideURL": "sample string 14",
      "payoutInfo": {
        "payoutType": "sample string 1",
        "useDefaultValues": true,
        "email": "sample string 3"
      },
      "customOption1Name": "sample string 15",
      "customOption1Value": "sample string 16",
      "customText1Name": "sample string 17",
      "customText1Value": "sample string 18",
      "customText2Name": "sample string 19",
      "customText2Value": "sample string 20",
      "programId": "4992885e-9465-4268-9d9b-5f1ee467e144",
      "programTitle": "sample string 22",
      "programName": "sample string 23",
      "referralUrl": "sample string 25",
      "referralCode": "sample string 24",
      "memberUrl": "sample string 26",
      "emailShares": 27,
      "socialShares": 28,
      "views": 29,
      "referrals": 30,
      "lastShare": "2018-07-19T13:22:35.8237267Z",
      "referralsApproved": 31,
      "referralsQualified": 32,
      "referralsPending": 33,
      "referralsApprovedAmount": 34.0,
      "rewardsPendingAmount": 35.0,
      "rewardsIssuedAmount": 36.0,
      "rewardAmountTotal": 37.0,
      "rewards": 38,
      "createDt": "2018-07-19T13:22:35.8237267Z",
      "utmSource": "sample string 40",
      "utmMedium": "sample string 41",
      "utmCampaign": "sample string 42",
      "browserReferrerUrl": "sample string 43",
      "lastViewIPAddress": "sample string 44"
    },
    {
      "id": "1eb7bb6b-1c4d-429d-ba73-7314590b7fd5",
      "displayName": "sample string 2",
      "firstName": "sample string 3",
      "lastName": "sample string 4",
      "email": "sample string 5",
      "phone": "sample string 6",
      "externalIdentifier": "sample string 7",
      "dateOfBirth": "2018-07-19T13:22:35.8237267Z",
      "addressLine1": "sample string 8",
      "addressLine2": "sample string 9",
      "city": "sample string 10",
      "countrySubdivision": "sample string 11",
      "country": "sample string 12",
      "postalCode": "sample string 13",
      "disabledFlag": true,
      "customOverrideURL": "sample string 14",
      "payoutInfo": {
        "payoutType": "sample string 1",
        "useDefaultValues": true,
        "email": "sample string 3"
      },
      "customOption1Name": "sample string 15",
      "customOption1Value": "sample string 16",
      "customText1Name": "sample string 17",
      "customText1Value": "sample string 18",
      "customText2Name": "sample string 19",
      "customText2Value": "sample string 20",
      "programId": "4992885e-9465-4268-9d9b-5f1ee467e144",
      "programTitle": "sample string 22",
      "programName": "sample string 23",
      "referralUrl": "sample string 25",
      "referralCode": "sample string 24",
      "memberUrl": "sample string 26",
      "emailShares": 27,
      "socialShares": 28,
      "views": 29,
      "referrals": 30,
      "lastShare": "2018-07-19T13:22:35.8237267Z",
      "referralsApproved": 31,
      "referralsQualified": 32,
      "referralsPending": 33,
      "referralsApprovedAmount": 34.0,
      "rewardsPendingAmount": 35.0,
      "rewardsIssuedAmount": 36.0,
      "rewardAmountTotal": 37.0,
      "rewards": 38,
      "createDt": "2018-07-19T13:22:35.8237267Z",
      "utmSource": "sample string 40",
      "utmMedium": "sample string 41",
      "utmCampaign": "sample string 42",
      "browserReferrerUrl": "sample string 43",
      "lastViewIPAddress": "sample string 44"
    }
  ]
}

application/xml, text/xml

Sample:
<MemberSet xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <offset>1</offset>
  <total>2</total>
  <message>sample string 3</message>
  <members>
    <member>
      <id>1eb7bb6b-1c4d-429d-ba73-7314590b7fd5</id>
      <displayName>sample string 2</displayName>
      <firstName>sample string 3</firstName>
      <lastName>sample string 4</lastName>
      <email>sample string 5</email>
      <phone>sample string 6</phone>
      <externalIdentifier>sample string 7</externalIdentifier>
      <dateOfBirth>2018-07-19T09:22:35.8237267-04:00</dateOfBirth>
      <addressLine1>sample string 8</addressLine1>
      <addressLine2>sample string 9</addressLine2>
      <city>sample string 10</city>
      <countrySubdivision>sample string 11</countrySubdivision>
      <country>sample string 12</country>
      <postalCode>sample string 13</postalCode>
      <disabledFlag>true</disabledFlag>
      <customOverrideURL>sample string 14</customOverrideURL>
      <payoutInfo>
        <email>sample string 3</email>
        <payoutType>sample string 1</payoutType>
        <useDefaultValues>true</useDefaultValues>
      </payoutInfo>
      <customOption1Name>sample string 15</customOption1Name>
      <customOption1Value>sample string 16</customOption1Value>
      <customText1Name>sample string 17</customText1Name>
      <customText1Value>sample string 18</customText1Value>
      <customText2Name>sample string 19</customText2Name>
      <customText2Value>sample string 20</customText2Value>
      <programId>4992885e-9465-4268-9d9b-5f1ee467e144</programId>
      <programTitle>sample string 22</programTitle>
      <programName>sample string 23</programName>
      <referralUrl>sample string 25</referralUrl>
      <referralCode>sample string 24</referralCode>
      <memberUrl>sample string 26</memberUrl>
      <emailShares>27</emailShares>
      <socialShares>28</socialShares>
      <views>29</views>
      <referrals>30</referrals>
      <lastShare>2018-07-19T09:22:35.8237267-04:00</lastShare>
      <referralsApproved>31</referralsApproved>
      <referralsQualified>32</referralsQualified>
      <referralsPending>33</referralsPending>
      <referralsApprovedAmount>34</referralsApprovedAmount>
      <rewardsPendingAmount>35</rewardsPendingAmount>
      <rewardsIssuedAmount>36</rewardsIssuedAmount>
      <rewardAmountTotal>37</rewardAmountTotal>
      <rewards>38</rewards>
      <createDt>2018-07-19T09:22:35.8237267-04:00</createDt>
      <utmSource>sample string 40</utmSource>
      <utmMedium>sample string 41</utmMedium>
      <utmCampaign>sample string 42</utmCampaign>
      <browserReferrerUrl>sample string 43</browserReferrerUrl>
      <lastViewIPAddress>sample string 44</lastViewIPAddress>
    </member>
    <member>
      <id>1eb7bb6b-1c4d-429d-ba73-7314590b7fd5</id>
      <displayName>sample string 2</displayName>
      <firstName>sample string 3</firstName>
      <lastName>sample string 4</lastName>
      <email>sample string 5</email>
      <phone>sample string 6</phone>
      <externalIdentifier>sample string 7</externalIdentifier>
      <dateOfBirth>2018-07-19T09:22:35.8237267-04:00</dateOfBirth>
      <addressLine1>sample string 8</addressLine1>
      <addressLine2>sample string 9</addressLine2>
      <city>sample string 10</city>
      <countrySubdivision>sample string 11</countrySubdivision>
      <country>sample string 12</country>
      <postalCode>sample string 13</postalCode>
      <disabledFlag>true</disabledFlag>
      <customOverrideURL>sample string 14</customOverrideURL>
      <payoutInfo>
        <email>sample string 3</email>
        <payoutType>sample string 1</payoutType>
        <useDefaultValues>true</useDefaultValues>
      </payoutInfo>
      <customOption1Name>sample string 15</customOption1Name>
      <customOption1Value>sample string 16</customOption1Value>
      <customText1Name>sample string 17</customText1Name>
      <customText1Value>sample string 18</customText1Value>
      <customText2Name>sample string 19</customText2Name>
      <customText2Value>sample string 20</customText2Value>
      <programId>4992885e-9465-4268-9d9b-5f1ee467e144</programId>
      <programTitle>sample string 22</programTitle>
      <programName>sample string 23</programName>
      <referralUrl>sample string 25</referralUrl>
      <referralCode>sample string 24</referralCode>
      <memberUrl>sample string 26</memberUrl>
      <emailShares>27</emailShares>
      <socialShares>28</socialShares>
      <views>29</views>
      <referrals>30</referrals>
      <lastShare>2018-07-19T09:22:35.8237267-04:00</lastShare>
      <referralsApproved>31</referralsApproved>
      <referralsQualified>32</referralsQualified>
      <referralsPending>33</referralsPending>
      <referralsApprovedAmount>34</referralsApprovedAmount>
      <rewardsPendingAmount>35</rewardsPendingAmount>
      <rewardsIssuedAmount>36</rewardsIssuedAmount>
      <rewardAmountTotal>37</rewardAmountTotal>
      <rewards>38</rewards>
      <createDt>2018-07-19T09:22:35.8237267-04:00</createDt>
      <utmSource>sample string 40</utmSource>
      <utmMedium>sample string 41</utmMedium>
      <utmCampaign>sample string 42</utmCampaign>
      <browserReferrerUrl>sample string 43</browserReferrerUrl>
      <lastViewIPAddress>sample string 44</lastViewIPAddress>
    </member>
  </members>
</MemberSet>