Skip to main content

Get Member Listing

Request​

POST:/{integrationId}/member/listing

Request Body​

Member Listing Input Model
FieldDescriptionType
pagePage index of returned records. Each page contains at most 100 records. Using a page index beyond the number of available pages will result in empty result.numberrequired
filterMember listing filter.Member Listing Filter Input Model
Member Listing Filter Input Model
FieldDescriptionType
memberIdMember Id filter.Int Filter Input Model
phoneNoPhone number filter.String Filter Input Model
mobileUserIdMobile user Id filter.String Filter Input Model
Example of Request Body
Get member listing using a integer filter

Available integer filter for member records is memberId. Add integer filters in member listing filter input model according to your needs.

Example: Get member records with specific member Ids.

{
  "page": 1,
  "filter": {
    "memberId": {
      "multiSelect": [3, 5, 7]
    }
  }
}

Example: Get member records with member Ids falling between a specific integer range.

{
  "page": 1,
  "filter": {
    "memberId": {
      "from": 1,
      "to": 7
    }
  }
}
Get member listing using a string filter

Available string filters for member records are phoneNo and mobileUserId. Add string filters in member listing filter input model according to your needs.

Example: Get member records with specific mobile user Ids.

For filtering specific string values, use the multiSelect field in the filter.

{
  "page": 1,
  "filter": {
    "mobileUserId": {
      "multiSelect": ["MU-000001", "MU-000002"]
    }
  }
}

Example: Get member records with mobile user Ids falling between a range of string values.

For filtering a range of string values, use the from and to fields in the filter.

{
  "page": 1,
  "filter": {
    "mobileUserId": {
      "from": "MU-000001",
      "to": "MU-000005"
    }
  }
}

Composite example:

{
  "page": 1,
  "filter": {
    "memberId": {
      "from": 1,
      "to": 7
    },
    "mobileUserId": {
      "multiSelect": ["MU-000001"]
    }
  }
}

Example of Request URL:

Parameters:
integrationId = d9cdb75e-da7c-43dc-8dee-7d786b464c59

URL:
POST: https://onerewards-integration-api.autocountcloud.com/d9cdb75e-da7c-43dc-8dee-7d786b464c59/member/listing

Response​

Success Response​

Status Code: 200

Response Body​

FieldDescriptionType
dataResponse data.array[Member View Model]
totalCountNumber of records that match the filter.number

Member View Model
FieldDescriptionType
memberIdMember record id.number
memberNoMember record number.string
memberLevelIdMember's membership record id.number
personalIdMember personal identification number.stringnullable
personalNameMember name.stringnullable
raceMember race/ethnicity. Refer here for more informations.string
genderMember gender. Refer here for more informations.char
titleMember title.stringnullable
dateOfBirthMember date of birth.datenullable
addressMember address.stringnullable
postCodeMember post code.stringnullable
mobilePhoneMember mobile phone number.stringnullable
emailMember email address.stringnullable
noteMember notes.stringnullable
activeMember status. true indicate member is active.boolean
joinDateMember joined date.date
expiryDateMember expiry date.datenullable
mobileUserIdThe id of mobile user linked to member. null if it is not linked to any mobile user.stringnullable
createdTimeStampMember creation timestamp.date
lastModifiedMember last modified timestamp.date
Example of Success Response Body
{
  "data": [
    {
      "memberId": 7,
      "memberNo": "M-0007",
      "memberLevelId": 3,
      "personalId": "000201-08-0425",
      "personalName": "John Arias",
      "race": "Malay",
      "gender": "M",
      "title": null,
      "dateOfBirth": "2000-02-01T00:00:00",
      "address": null,
      "postcode": null,
      "mobilePhone": "+60177684630",
      "email": null,
      "note": null,
      "active": true,
      "joinDate": "2023-09-08T00:00:00",
      "expiryDate": null,
      "mobileUserId": "MU-000001",
      "createdTimeStamp": "2023-09-08T16:53:11.082514",
      "lastModified": "2023-10-09T10:49:24.042997"
    }
  ],
  "totalCount": 1
}

Error Response​