Returns a list of members within a loyalty program
Request Information
Headers
| Name | Description | Type | Additional information |
|---|---|---|---|
| Authentication |
Authentication token |
string |
Required |
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| accountid |
Your account id |
globally unique identifier |
Required |
| skip |
Skip record count |
integer |
Optional Default value is 0 |
| take |
Take record count |
integer |
Optional Default value is 500 |
Body Parameters
None.
Response Information
Resource Description
Member list
| Name | Description | Type | Additional information |
|---|---|---|---|
| Data | PageListOfApiLPMember |
None. |
|
| Success | boolean |
None. |
|
| Messages | Collection of ErrorMessage |
None. |
Response Formats
application/json
Sample:
{
"Data": {
"Items": [
{
"Id": "30F0B01C-8B37-4D64-86BC-C2C88F9CA276",
"FirstName": "First name",
"LastName": "Last name",
"Phone": "972 999 9999",
"Email": "someemail@gmail.com",
"Birthday": "2014-04-01T12:13:19.903",
"BirthdayYear": 2014,
"Gender": "M",
"Notes": "Any notes",
"ExternalAccountId": "Any external account id if exist",
"StatusCode": "A",
"PointBalance": 55,
"StatusDescription": "Active"
},
{
"Id": "7989DBC5-87FB-4B48-8975-37DA8A9743A9",
"FirstName": "First name",
"LastName": "Last name",
"Phone": "972 999 9999",
"Email": "someemail2@gmail.com",
"Birthday": "2013-04-01T12:13:19.903",
"BirthdayYear": 2014,
"Gender": "M",
"Notes": "Any notes",
"ExternalAccountId": "Any external account id if exist",
"StatusCode": "A",
"PointBalance": 55,
"StatusDescription": "Active"
}
],
"AllCount": 2
},
"Success": true,
"Messages": []
}