Get Members
Gets the details of all members of a parent company. Results can be narrowed down by using the query parameters. By specifying the loyaltyNumber or the profileId as query parameter, you can get details of a single member.
Note:
1) Member must be already part of the loyalty program.
2) Query parameter used to get results must be part of member information.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
Loyalty number of the member. Either the loyaltyNumber or the profileId must be specified. It is generated in the response of the Enroll Member endpoint - POST /v1/members/.
Profile ID of the member. Either the loyaltyNumber or the profileId must be specified. It is generated in the response of the Enroll Member endpoint - POST /v1/members/.
Redemption choice. Supported options are Bank and Auto. If the redemptionChoice is 'auto,' the points are automatically converted to rewards. When the redemptionChoice is 'bank,' the points are converted to rewards at the member’s requests.
First name of member
Middle name of member
Last name of member
Phone number given for enrollment (without space or dash)
Email address given for enrollment
Address of member
Postal code of address
City name
Country name
Abbreviation of country name
State name
Abbreviation of state name
Starting number of record (within the total number of records) in the response. Default value is 0.
Ending number of record (from the offset number) in the response. Default value is 20.
Response
Member details with enrollment status
Message corresponding to the call
Dictionary of lists with different number of errors or exceptions.
Member details
Status code of call
Was this page helpful?