Get Member Tiers
1 min
GET
https://api.b.preview.loyaltyservices.io/api/v3/members/{memberIdentifier}/tiers
Path Parameters
- memberIdentifierstringrequiredExampleDescriptionMin Length1Max Length200
Query Parameters
- includeRolloverNightsbooleanDescriptionDefaultfalse
Responses
200
- MemberTiersResponse
- pastTiersMemberTier[]Description
- tierCodestringrequiredExampleDescription
- descriptionstringExampleDescriptionMin Length0Max Length10
- rankinteger<int32>requiredExampleDescriptionFormatint32
- typeCodestringExampleDescription
- startDatestring<date>ExampleDescriptionFormatdate
- endDatestring<date>ExampleDescriptionFormatdate
- grandFatheredbooleanDescription
- earnedbooleanExampleDescription
- lifetimebooleanDescription
- rolloverNightsintegerExampleDescription
- assignmentReasonstring<bonus | creditcard | management | manual | promotion | stepdown | system | tiergift>ExampleDescriptionAllowedbonuscreditcardmanagementmanualpromotionstepdownsystemtiergift
- assignmentReasonObjectExternalReferencestringDescription
- assignmentReasonObjectDescriptionstringExampleDescription
- createdBystringDescription
- sourceCouponUseMemberTierCouponUseDescription
- couponCodestringExampleDescription
- offerCodestringExampleDescription
- offerNamestringExampleDescription
- startDatestring<date>ExampleDescriptionFormatdate
- endDatestring<date>ExampleDescriptionFormatdate
- currentTierMemberTier
- tierCodestringrequiredExampleDescription
- descriptionstringExampleDescriptionMin Length0Max Length10
- rankinteger<int32>requiredExampleDescriptionFormatint32
- typeCodestringExampleDescription
- startDatestring<date>ExampleDescriptionFormatdate
- endDatestring<date>ExampleDescriptionFormatdate
- grandFatheredbooleanDescription
- earnedbooleanExampleDescription
- lifetimebooleanDescription
- rolloverNightsintegerExampleDescription
- assignmentReasonstring<bonus | creditcard | management | manual | promotion | stepdown | system | tiergift>ExampleDescriptionAllowedbonuscreditcardmanagementmanualpromotionstepdownsystemtiergift
- assignmentReasonObjectExternalReferencestringDescription
- assignmentReasonObjectDescriptionstringExampleDescription
- createdBystringDescription
- sourceCouponUseMemberTierCouponUseDescription
- couponCodestringExampleDescription
- offerCodestringExampleDescription
- offerNamestringExampleDescription
- startDatestring<date>ExampleDescriptionFormatdate
- endDatestring<date>ExampleDescriptionFormatdate
- projectedTierMemberTier
- tierCodestringrequiredExampleDescription
- descriptionstringExampleDescriptionMin Length0Max Length10
- rankinteger<int32>requiredExampleDescriptionFormatint32
- typeCodestringExampleDescription
- startDatestring<date>ExampleDescriptionFormatdate
- endDatestring<date>ExampleDescriptionFormatdate
- grandFatheredbooleanDescription
- earnedbooleanExampleDescription
- lifetimebooleanDescription
- rolloverNightsintegerExampleDescription
- assignmentReasonstring<bonus | creditcard | management | manual | promotion | stepdown | system | tiergift>ExampleDescriptionAllowedbonuscreditcardmanagementmanualpromotionstepdownsystemtiergift
- assignmentReasonObjectExternalReferencestringDescription
- assignmentReasonObjectDescriptionstringExampleDescription
- createdBystringDescription
- sourceCouponUseMemberTierCouponUseDescription
- couponCodestringExampleDescription
- offerCodestringExampleDescription
- offerNamestringExampleDescription
- startDatestring<date>ExampleDescriptionFormatdate
- endDatestring<date>ExampleDescriptionFormatdate
- earningTierMemberFutureTier
- tierCodestringExampleDescription
- descriptionstringExampleDescriptionMin Length0Max Length10
- ranknumberExampleDescription
- typeCodestringExampleDescription
- qualificationDatestring<date>ExampleDescriptionFormatdate
- awardedbooleanExampleDescription
- expirationDatestring<date>ExampleDescriptionFormatdate
- createDatestring<date>ExampleDescriptionFormatdate
- lifetimebooleanDescription
- countersMemberFutureTierCounter[]Description
- counterTypeCodestringExampleDescription
- accruedAmountnumberExampleDescription
- requiredAmountnumberExampleDescription
- rolloverAmountnumberExampleDescription
- rolledOverAmountnumberExampleDescription
- remainingAmountnumberExampleDescription
- aspirationTiersMemberFutureTier[]Description
- tierCodestringExampleDescription
- descriptionstringExampleDescriptionMin Length0Max Length10
- ranknumberExampleDescription
- typeCodestringExampleDescription
- qualificationDatestring<date>ExampleDescriptionFormatdate
- awardedbooleanExampleDescription
- expirationDatestring<date>ExampleDescriptionFormatdate
- createDatestring<date>ExampleDescriptionFormatdate
- lifetimebooleanDescription
- countersMemberFutureTierCounter[]Description
- counterTypeCodestringExampleDescription
- accruedAmountnumberExampleDescription
- requiredAmountnumberExampleDescription
- rolloverAmountnumberExampleDescription
- rolledOverAmountnumberExampleDescription
- remainingAmountnumberExampleDescription
- nextTierRolloverDatestring<date>ExampleDescriptionFormatdate
400
- ErrorResponse
- errorsValidationError[]Description
- codestringDescription
- fieldNamestringDescription
- messagestringDescription
- messageParametersobject[]Description
401
403
500
curl
curl --request GET \
--url 'https://api.b.preview.loyaltyservices.io/api/v3/members/{memberIdentifier}/tiers?includeRolloverNights=boolean' \
--header 'accept: application/json'javascript
var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");
var requestOptions = {
method: 'GET',
headers: myHeaders,
redirect: 'follow'
};
fetch("https://api.b.preview.loyaltyservices.io/api/v3/members/{memberIdentifier}/tiers?includeRolloverNights=boolean", requestOptions)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log('error', error));ruby
require "uri"
require "json"
require "net/http"
url = URI("https://api.b.preview.loyaltyservices.io/api/v3/members/{memberIdentifier}/tiers?includeRolloverNights=boolean")
https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true
request = Net::HTTP::Get.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
response = https.request(request)
puts response.read_body
python
import requests
import json
url = "https://api.b.preview.loyaltyservices.io/api/v3/members/{memberIdentifier}/tiers?includeRolloverNights=boolean"
payload = {}
headers = {
'accept': 'application/json',
'content-type': 'application/json'
}
response = requests.request("GET", url, headers=headers, data=payload)
print(response.text)
200
// Success
{
"pastTiers": [
{
"tierCode": "B",
"description": "Base",
"rank": 10,
"typeCode": "Earned",
"startDate": "2020-01-01",
"endDate": "2020-12-31",
"grandFathered": false,
"earned": true,
"lifetime": false,
"rolloverNights": 10,
"assignmentReason": "bonus",
"assignmentReasonObjectExternalReference": "",
"assignmentReasonObjectDescription": "Adjustment Bonus 1000 Points",
"createdBy": "",
"sourceCouponUse": {
"couponCode": "113456816",
"offerCode": "Q1UP",
"offerName": "Q1 upgrades",
"startDate": "2025-01-15",
"endDate": "2026-01-15"
}
}
],
"currentTier": {
"tierCode": "B",
"description": "Base",
"rank": 10,
"typeCode": "Earned",
"startDate": "2020-01-01",
"endDate": "2020-12-31",
"grandFathered": false,
"earned": true,
"lifetime": false,
"rolloverNights": 10,
"assignmentReason": "bonus",
"assignmentReasonObjectExternalReference": "",
"assignmentReasonObjectDescription": "Adjustment Bonus 1000 Points",
"createdBy": "",
"sourceCouponUse": {
"couponCode": "113456816",
"offerCode": "Q1UP",
"offerName": "Q1 upgrades",
"startDate": "2025-01-15",
"endDate": "2026-01-15"
}
},
"projectedTier": {
"tierCode": "B",
"description": "Base",
"rank": 10,
"typeCode": "Earned",
"startDate": "2020-01-01",
"endDate": "2020-12-31",
"grandFathered": false,
"earned": true,
"lifetime": false,
"rolloverNights": 10,
"assignmentReason": "bonus",
"assignmentReasonObjectExternalReference": "",
"assignmentReasonObjectDescription": "Adjustment Bonus 1000 Points",
"createdBy": "",
"sourceCouponUse": {
"couponCode": "113456816",
"offerCode": "Q1UP",
"offerName": "Q1 upgrades",
"startDate": "2025-01-15",
"endDate": "2026-01-15"
}
},
"earningTier": {
"tierCode": "S",
"description": "Silver",
"rank": 20,
"typeCode": "Earned",
"qualificationDate": "2020-06-15",
"awarded": true,
"expirationDate": "2020-12-31",
"createDate": "2020-01-01",
"lifetime": false,
"counters": [
{
"counterTypeCode": "Spend",
"accruedAmount": 1,
"requiredAmount": 100,
"rolloverAmount": 15,
"rolledOverAmount": 10,
"remainingAmount": 8
}
]
},
"aspirationTiers": [
{
"tierCode": "S",
"description": "Silver",
"rank": 20,
"typeCode": "Earned",
"qualificationDate": "2020-06-15",
"awarded": true,
"expirationDate": "2020-12-31",
"createDate": "2020-01-01",
"lifetime": false,
"counters": [
{
"counterTypeCode": "Spend",
"accruedAmount": 1,
"requiredAmount": 100,
"rolloverAmount": 15,
"rolledOverAmount": 10,
"remainingAmount": 8
}
]
}
],
"nextTierRolloverDate": "2020-01-01"
}400
// Bad request
{
"errors": [
{
"code": "",
"fieldName": "",
"message": "",
"messageParameters": [
{}
]
}
]
}401
// Unauthorized
403
// Forbidden
500
// Internal error