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}&offset={offset}&count={count}

NameDescriptionTypeAdditional information
programId

ID of the program. Optional.

string

None.

query

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

string

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": "31cb490a-21e6-4a3b-8025-51d2ac4ec663",
      "firstName": "sample string 2",
      "lastName": "sample string 3",
      "email": "sample string 4",
      "phone": "sample string 5",
      "externalIdentifier": "sample string 6",
      "dateOfBirth": "2018-01-23T03:09:52.6791944Z",
      "addressLine1": "sample string 7",
      "addressLine2": "sample string 8",
      "city": "sample string 9",
      "countrySubdivision": "sample string 10",
      "country": "sample string 11",
      "postalCode": "sample string 12",
      "disabledFlag": true,
      "payoutInfo": {
        "payoutType": "sample string 1",
        "useDefaultValues": true,
        "email": "sample string 3"
      },
      "customOption1Name": "sample string 13",
      "customOption1Value": "sample string 14",
      "customText1Name": "sample string 15",
      "customText1Value": "sample string 16",
      "customText2Name": "sample string 17",
      "customText2Value": "sample string 18",
      "programId": "dbae9fe6-ac0f-4c11-b302-4581f0cfd92e",
      "programTitle": "sample string 20",
      "programName": "sample string 21",
      "referralCode": "sample string 22",
      "referralUrl": "sample string 23",
      "memberUrl": "sample string 24",
      "emailShares": 25,
      "socialShares": 26,
      "views": 27,
      "referrals": 28,
      "lastShare": "2018-01-23T03:09:52.6791944Z",
      "referralsApproved": 29,
      "referralsQualified": 30,
      "referralsApprovedAmount": 31.0,
      "rewardsPendingAmount": 32.0,
      "rewardsIssuedAmount": 33.0,
      "createDt": "2018-01-23T03:09:52.6791944Z"
    },
    {
      "id": "31cb490a-21e6-4a3b-8025-51d2ac4ec663",
      "firstName": "sample string 2",
      "lastName": "sample string 3",
      "email": "sample string 4",
      "phone": "sample string 5",
      "externalIdentifier": "sample string 6",
      "dateOfBirth": "2018-01-23T03:09:52.6791944Z",
      "addressLine1": "sample string 7",
      "addressLine2": "sample string 8",
      "city": "sample string 9",
      "countrySubdivision": "sample string 10",
      "country": "sample string 11",
      "postalCode": "sample string 12",
      "disabledFlag": true,
      "payoutInfo": {
        "payoutType": "sample string 1",
        "useDefaultValues": true,
        "email": "sample string 3"
      },
      "customOption1Name": "sample string 13",
      "customOption1Value": "sample string 14",
      "customText1Name": "sample string 15",
      "customText1Value": "sample string 16",
      "customText2Name": "sample string 17",
      "customText2Value": "sample string 18",
      "programId": "dbae9fe6-ac0f-4c11-b302-4581f0cfd92e",
      "programTitle": "sample string 20",
      "programName": "sample string 21",
      "referralCode": "sample string 22",
      "referralUrl": "sample string 23",
      "memberUrl": "sample string 24",
      "emailShares": 25,
      "socialShares": 26,
      "views": 27,
      "referrals": 28,
      "lastShare": "2018-01-23T03:09:52.6791944Z",
      "referralsApproved": 29,
      "referralsQualified": 30,
      "referralsApprovedAmount": 31.0,
      "rewardsPendingAmount": 32.0,
      "rewardsIssuedAmount": 33.0,
      "createDt": "2018-01-23T03:09:52.6791944Z"
    }
  ]
}

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>31cb490a-21e6-4a3b-8025-51d2ac4ec663</id>
      <firstName>sample string 2</firstName>
      <lastName>sample string 3</lastName>
      <email>sample string 4</email>
      <phone>sample string 5</phone>
      <externalIdentifier>sample string 6</externalIdentifier>
      <dateOfBirth>2018-01-22T22:09:52.6791944-05:00</dateOfBirth>
      <addressLine1>sample string 7</addressLine1>
      <addressLine2>sample string 8</addressLine2>
      <city>sample string 9</city>
      <countrySubdivision>sample string 10</countrySubdivision>
      <country>sample string 11</country>
      <postalCode>sample string 12</postalCode>
      <disabledFlag>true</disabledFlag>
      <payoutInfo>
        <email>sample string 3</email>
        <payoutType>sample string 1</payoutType>
        <useDefaultValues>true</useDefaultValues>
      </payoutInfo>
      <customOption1Name>sample string 13</customOption1Name>
      <customOption1Value>sample string 14</customOption1Value>
      <customText1Name>sample string 15</customText1Name>
      <customText1Value>sample string 16</customText1Value>
      <customText2Name>sample string 17</customText2Name>
      <customText2Value>sample string 18</customText2Value>
      <programId>dbae9fe6-ac0f-4c11-b302-4581f0cfd92e</programId>
      <programTitle>sample string 20</programTitle>
      <programName>sample string 21</programName>
      <referralCode>sample string 22</referralCode>
      <referralUrl>sample string 23</referralUrl>
      <memberUrl>sample string 24</memberUrl>
      <emailShares>25</emailShares>
      <socialShares>26</socialShares>
      <views>27</views>
      <referrals>28</referrals>
      <lastShare>2018-01-22T22:09:52.6791944-05:00</lastShare>
      <referralsApproved>29</referralsApproved>
      <referralsQualified>30</referralsQualified>
      <referralsApprovedAmount>31</referralsApprovedAmount>
      <rewardsPendingAmount>32</rewardsPendingAmount>
      <rewardsIssuedAmount>33</rewardsIssuedAmount>
      <createDt>2018-01-22T22:09:52.6791944-05:00</createDt>
    </member>
    <member>
      <id>31cb490a-21e6-4a3b-8025-51d2ac4ec663</id>
      <firstName>sample string 2</firstName>
      <lastName>sample string 3</lastName>
      <email>sample string 4</email>
      <phone>sample string 5</phone>
      <externalIdentifier>sample string 6</externalIdentifier>
      <dateOfBirth>2018-01-22T22:09:52.6791944-05:00</dateOfBirth>
      <addressLine1>sample string 7</addressLine1>
      <addressLine2>sample string 8</addressLine2>
      <city>sample string 9</city>
      <countrySubdivision>sample string 10</countrySubdivision>
      <country>sample string 11</country>
      <postalCode>sample string 12</postalCode>
      <disabledFlag>true</disabledFlag>
      <payoutInfo>
        <email>sample string 3</email>
        <payoutType>sample string 1</payoutType>
        <useDefaultValues>true</useDefaultValues>
      </payoutInfo>
      <customOption1Name>sample string 13</customOption1Name>
      <customOption1Value>sample string 14</customOption1Value>
      <customText1Name>sample string 15</customText1Name>
      <customText1Value>sample string 16</customText1Value>
      <customText2Name>sample string 17</customText2Name>
      <customText2Value>sample string 18</customText2Value>
      <programId>dbae9fe6-ac0f-4c11-b302-4581f0cfd92e</programId>
      <programTitle>sample string 20</programTitle>
      <programName>sample string 21</programName>
      <referralCode>sample string 22</referralCode>
      <referralUrl>sample string 23</referralUrl>
      <memberUrl>sample string 24</memberUrl>
      <emailShares>25</emailShares>
      <socialShares>26</socialShares>
      <views>27</views>
      <referrals>28</referrals>
      <lastShare>2018-01-22T22:09:52.6791944-05:00</lastShare>
      <referralsApproved>29</referralsApproved>
      <referralsQualified>30</referralsQualified>
      <referralsApprovedAmount>31</referralsApprovedAmount>
      <rewardsPendingAmount>32</rewardsPendingAmount>
      <rewardsIssuedAmount>33</rewardsIssuedAmount>
      <createDt>2018-01-22T22:09:52.6791944-05:00</createDt>
    </member>
  </members>
</MemberSet>