Time	Status	User Agent
Retrieving recent requests…

Get Tier

Retrieves the details of a single tier. Look up a published tier by its slabId or a draft by its tierUniqueId. If the published tier has an edit in progress, the response includes both versions: the live version and the draft.

Example request

curl -X GET "https://eu.intouch.capillarytech.com/v3/tiers/ut-973-009" \
  -H "Authorization: Basic <base64-encoded-credentials>"

curl -X GET "https://eu.intouch.capillarytech.com/v3/tiers/25220" \
  -H "Authorization: Basic <base64-encoded-credentials>"

Note: Lookup by slabId works only for tiers created through this API. For tiers created outside this API, it returns HTTP 404 with error 9056. Retrieve those with List All Tiers using ?programId=<id>&tier=<slabId> instead.

Prerequisites

Authentication: Basic auth or OAuth token with loyalty program read permissions.

Resource information


Pagination support	No
Batch support	No

Path parameters

Field	Type	Required	Description
`tierId`	string	Required	Tier ID. Pass the `slabId` (from List All Tiers) to retrieve a published tier and any draft edit of it, or the `tierUniqueId` (from Create Tier) to retrieve a draft.

Example response

{
  "data": [
    {
      "tierUniqueId": "ut-973-009",
      "objectId": "6a2121936497e74ec3517ad8",
      "name": "Platinum",
      "description": "Premium tier for top spenders",
      "color": "#E5E4E2",
      "serialNumber": 9,
      "eligibility": {
        "kpiType": "CURRENT_POINTS",
        "threshold": 75000.0,
        "upgradeType": "LAZY"
      },
      "meta": {
        "createdBy": "75237721",
        "createdAt": "2026-06-04T06:56:19Z",
        "updatedBy": "75237721",
        "updatedAt": "2026-06-04T06:56:19Z"
      },
      "status": "DRAFT",
      "origin": "MONGO_ONLY",
      "renewal": {
        "periodType": "SLAB_UPGRADE",
        "periodValue": "12",
        "unit": "NUM_MONTHS",
        "criteriaType": "Same as eligibility"
      }
    }
  ],
  "errors": null,
  "warnings": null
}

Response parameters

Field	Type	Description
`data`	array	List of one or two tier entries. Two entries are returned when a published tier has an edit in progress. Fields with `null` values are omitted.
`.status`	string	Current stage of the tier lifecycle. `LIVE` indicates the published version of a tier. Possible values: `LIVE`, `DRAFT`, `PENDING_APPROVAL`, `REJECTED`, `ACTIVE`, `DELETED`, `SNAPSHOT`, `PUBLISH_FAILED`.
`.origin`	string	Indicates which version of the tier data this entry represents. Possible values: `BOTH` (published tier that also has a draft), `MONGO_ONLY` (draft not yet published), `LEGACY_SQL_ONLY` (tier created outside this API).
`.slabId`	integer	Unique ID of the published tier, returned by List All Tiers. `null` until the tier is approved and published.
`.tierUniqueId`	string	Unique ID assigned to a tier created through this API, returned by Create Tier. `null` for tiers created outside this API.
`.objectId`	string	Unique ID of this tier record. Use it with Update Tier, Delete Tier, and the approval endpoints.
`.name`	string	Tier name.
`.description`	string	Tier description.
`.color`	string	Display color in hex format.
`.serialNumber`	integer	Tier position in the program's tier ladder.
`.tierStartDate`	timestamp	Date and time when the tier was published, in ISO 8601 format (`YYYY-MM-DDTHH:MM:SSZ`), returned in the server time zone. Present on `LIVE` entries only.
`.eligibility`	object	Object containing the conditions a customer must meet to enter this tier.
`..kpiType`	enum	KPI the threshold is measured against. Possible values: `CURRENT_POINTS`, `CUMULATIVE_POINTS`, `CUMULATIVE_PURCHASES`, `TRACKER_VALUE_BASED`.
`..threshold`	number	KPI value at which a customer upgrades into this tier.
`..upgradeType`	enum	When tier upgrades are evaluated. Possible values: `EAGER`, `DYNAMIC`, `LAZY`.
`.renewal`	object	Object containing the tier's validity period and renewal settings. See List All Tiers for the full field reference.
`.downgrade`	object	Object containing the tier's downgrade settings. Read-only.
`.communicationModeConfig`	object	Object containing the communication channels (such as SMS, email, and WhatsApp) used to notify customers about tier events. `null` on draft entries.
`.rejectionComment`	string	Reviewer's comment. Present only when `status` is `REJECTED`.
`.meta`	object	Object containing details of who created, updated, approved, or rejected the tier, and when.
`..createdBy`	string	User or till ID of the person who created the tier.
`..createdAt`	timestamp	Date and time when the tier was created, in ISO 8601 format (`YYYY-MM-DDTHH:MM:SSZ`), returned in the server time zone.
`..updatedBy`	string	User or till ID of the person who last updated the tier.
`..updatedAt`	timestamp	Date and time when the tier was last updated, in ISO 8601 format (`YYYY-MM-DDTHH:MM:SSZ`), returned in the server time zone.
`..approvedBy`	string	User ID of the reviewer who approved the tier.
`..approvedAt`	timestamp	Date and time when the tier was approved, in ISO 8601 format (`YYYY-MM-DDTHH:MM:SSZ`), returned in the server time zone.
`..rejectedBy`	string	User ID of the reviewer who rejected the tier.
`..rejectedAt`	timestamp	Date and time when the tier was rejected, in ISO 8601 format (`YYYY-MM-DDTHH:MM:SSZ`), returned in the server time zone.
`..rejectionComment`	string	Reviewer's comment on rejection.
`.customerCount`	integer	Number of active customers currently in this tier. `null` when count data is unavailable.
`.countRefreshedAt`	timestamp	Date and time when `customerCount` was last refreshed, in ISO 8601 format (`YYYY-MM-DDTHH:MM:SSZ`), returned in the server time zone.
`errors`	array	Error list. `null` on success.
`warnings`	array	Warning list. `null` on success.

Error and warning codes

Code	Error number	Type	Description
`TIER.NOT_FOUND`	9056	Error	No tier matches the given `tierId`. HTTP 404.