Skip to main content
GET
/
v3
/
profiles
/
{profile}
/
tiers
Read Profile Tier
curl --request GET \
  --url http://localhost/api/v3/profiles/{profile}/tiers
{
  "data": {
    "id": 123,
    "profile_id": "<string>",
    "current_tier": {
      "id": 123,
      "name": "<string>",
      "handle": "<string>",
      "is_floor": "<string>",
      "value_min": 123,
      "value_maintain": 123,
      "is_assignable": true,
      "internal_notes": "<string>",
      "description": "<string>",
      "short_description": "<string>",
      "long_description": "<string>",
      "terms_conditions": "<string>",
      "icon": "<string>",
      "image_url": "<string>",
      "earn_instructions": "<string>",
      "disable_credit": true,
      "tags": [
        "<string>"
      ],
      "meta": [
        "<unknown>"
      ],
      "region_id": 123,
      "region": {
        "id": 123,
        "name": "<string>",
        "handle": "<string>",
        "is_default": true,
        "currency": "<string>",
        "created_at": "<string>",
        "updated_at": "<string>"
      },
      "created_at": "<string>",
      "updated_at": "<string>"
    },
    "next_tier": {
      "id": 123,
      "name": "<string>",
      "handle": "<string>",
      "is_floor": "<string>",
      "value_min": 123,
      "value_maintain": 123,
      "is_assignable": true,
      "internal_notes": "<string>",
      "description": "<string>",
      "short_description": "<string>",
      "long_description": "<string>",
      "terms_conditions": "<string>",
      "icon": "<string>",
      "image_url": "<string>",
      "earn_instructions": "<string>",
      "disable_credit": true,
      "tags": [
        "<string>"
      ],
      "meta": [
        "<unknown>"
      ],
      "region_id": 123,
      "region": {
        "id": 123,
        "name": "<string>",
        "handle": "<string>",
        "is_default": true,
        "currency": "<string>",
        "created_at": "<string>",
        "updated_at": "<string>"
      },
      "created_at": "<string>",
      "updated_at": "<string>"
    },
    "prev_tier": {
      "id": 123,
      "name": "<string>",
      "handle": "<string>",
      "is_floor": "<string>",
      "value_min": 123,
      "value_maintain": 123,
      "is_assignable": true,
      "internal_notes": "<string>",
      "description": "<string>",
      "short_description": "<string>",
      "long_description": "<string>",
      "terms_conditions": "<string>",
      "icon": "<string>",
      "image_url": "<string>",
      "earn_instructions": "<string>",
      "disable_credit": true,
      "tags": [
        "<string>"
      ],
      "meta": [
        "<unknown>"
      ],
      "region_id": 123,
      "region": {
        "id": 123,
        "name": "<string>",
        "handle": "<string>",
        "is_default": true,
        "currency": "<string>",
        "created_at": "<string>",
        "updated_at": "<string>"
      },
      "created_at": "<string>",
      "updated_at": "<string>"
    },
    "is_floor": "<string>",
    "current_credit": "<string>",
    "current_progress": "<string>",
    "current_remain": "<string>",
    "next_progress": "<string>",
    "next_remain": "<string>",
    "total_points_12m": "<string>",
    "total_points_achievement": "<string>",
    "next_progress_change_at": "<string>",
    "anniversary_at": "<string>",
    "maintained_at": "<string>",
    "assigned_at": "<string>",
    "achieved_at": "<string>",
    "created_at": "<string>",
    "updated_at": "<string>"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.omneo.io/llms.txt

Use this file to discover all available pages before exploring further.

Tier DefinitionsThe Profile tier contains information about the tier in relation to the profile. Tier definitions contain data unique to each individual tier. For further information about the structure of data unique to each tier, you can review Tier Definitions
{
   "id":663,
   "profile_id":"92441ab4-331a-41dc-b598-9fa22311b3",
   "current_tier":{
      "id":1,
      "name":"Bronze",
      "handle":"bronze",
      "is_floor":true,
      "value_min":0,
      "value_maintain":0,
      "is_assignable":false,
      "internal_notes":null,
      "description":null,
      "short_description":"Bronze",
      "long_description":"<p>Bronze Tier </p>",
      "terms_conditions":null,
      "icon":null,
      "image_url":null,
      "earn_instructions":null,
      "tags":[

      ],
      "created_at":"2020-05-15 11:18:24",
      "updated_at":"2020-11-19 11:18:24"
   },
   "next_tier":{
      "id":2,
      "name":"Silver",
      "handle":"silver",
      "is_floor":false,
      "value_min":1000,
      "value_maintain":1000,
      "is_assignable":true,
      "internal_notes":null,
      "description":null,
      "short_description":"★",
      "long_description":"<p>Silver Tier</p>",
      "terms_conditions":null,
      "icon":null,
      "image_url":null,
      "earn_instructions":null,
      "tags":[

      ],
      "created_at":"2020-05-15 11:19:04",
      "updated_at":"2020-11-19 11:17:47"
   },
   "prev_tier":null,
   "is_floor":true,
   "current_credit":0,
   "current_progress":0,
   "current_remain":0,
   "next_progress":0,
   "next_remain":1000,
   "total_points_12m":0,
   "total_points_achievement":null,
   "anniversary_at":"2022-01-21 23:59:59",
   "assigned_at":null,
   "achieved_at":"2021-01-21 00:00:00",
   "created_at":"2021-01-21 01:07:28",
   "updated_at":"2021-01-21 01:07:28"
}

​
Tier Properties

Header level tier data containing information about the profiles tier progress as a whole
id INTEGER READ-ONLYThe ID of the profile tier record
profile_id STRINGThe profile_id of the profile the tier is attached to.
current_tier OBJECT TIERThe current tier the profile has achieved.
next_tier OBJECT TIERThe next level tier the profile can achieve
prev_tier OBJECT TIERThe previous tier the profile has achieved
is_floor BOOLEANDenotes whether this profile is currently on the lowest tier the profile can achieve
current_credit INTEGERThe total points issues this year, minus the value_min How much credit was applied when the member achieved this tier. For example, if their annual spend was 600whenthetierwasachievedbutthetierthresholdis600 when the tier was achieved but the tier threshold is 500 they will have a $100 credit toward their maintenance goal for that year.
current_progress INTEGERHow much the member has spent since achieving their current tier. This marks their “progress” towards achieving the maintenance goal for the current year.
current_remain INTEGERThe remaining points required to achieve the maintenance goal for the current tier, for the current year
next_progress INTEGERHow much the member has spent in the last 365 days. This marks their “progress” towards achieving the next tier.
next_remain INTEGERThe remaining points required to achieve the next tier.
total_points_12m INTEGERThe total amount of point achieved in the last 12m
total_points_achievement INTEGERThe total points achieved issues after the achieved_at date (the date of the latests achieved tier)
anniversary_at DATE-TIMEthe anniversary of the date the member achieved their latest tier
assigned_at DATE-TIMEThe date the current tier was manually assigned to the member. If the member achieved this normally, this field will be null
achieved_at DATE-TIMEThe date the member achieve their current profile tier
created_at DATE-TIME READ-ONLYThe UTC date & time the Profile record was created in ISO 8601 format.
updated_at DATE-TIME READ-ONLYThe UTC date & time the Profile record was last updated in ISO 8601 format.

Path Parameters

​
profile
string<uuid>
required

The profile ID

Response

​
data
object
required