Get reward redemption status

curl --request GET \
  --url https://{brand}.extole.io/api/v4/me/rewards/status \
  --header 'Authorization: <api-key>'

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://{brand}.extole.io/api/v4/me/rewards/status', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{brand}.extole.io/api/v4/me/rewards/status",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://{brand}.extole.io/api/v4/me/rewards/status"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://{brand}.extole.io/api/v4/me/rewards/status")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "quality_results": [
    {
      "quality_rule_results": [
        {
          "rule_name": "<string>"
        }
      ]
    }
  ],
  "reward": {
    "action_id": "<string>",
    "campaign_id": "<string>",
    "cause_event_id": "<string>",
    "container": "<string>",
    "created_at": "2025-10-24T02:00:00-07:00",
    "data": {},
    "email": "<string>",
    "expires_at": "2025-10-24T02:00:00-07:00",
    "face_value": 123,
    "journey_key": {
      "name": "<string>",
      "value": "<string>"
    },
    "journey_name": "<string>",
    "partner_reward_id": "<string>",
    "partner_reward_supplier_id": "<string>",
    "partner_user_id": "<string>",
    "person_id": "<string>",
    "reward_id": "<string>",
    "reward_supplier_id": "<string>",
    "root_event_id": "<string>",
    "sandbox": "<string>"
  }
}

GET

api

rewards

status

Get reward redemption status

curl --request GET \
  --url https://{brand}.extole.io/api/v4/me/rewards/status \
  --header 'Authorization: <api-key>'

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://{brand}.extole.io/api/v4/me/rewards/status', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{brand}.extole.io/api/v4/me/rewards/status",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://{brand}.extole.io/api/v4/me/rewards/status"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://{brand}.extole.io/api/v4/me/rewards/status")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "quality_results": [
    {
      "quality_rule_results": [
        {
          "rule_name": "<string>"
        }
      ]
    }
  ],
  "reward": {
    "action_id": "<string>",
    "campaign_id": "<string>",
    "cause_event_id": "<string>",
    "container": "<string>",
    "created_at": "2025-10-24T02:00:00-07:00",
    "data": {},
    "email": "<string>",
    "expires_at": "2025-10-24T02:00:00-07:00",
    "face_value": 123,
    "journey_key": {
      "name": "<string>",
      "value": "<string>"
    },
    "journey_name": "<string>",
    "partner_reward_id": "<string>",
    "partner_reward_supplier_id": "<string>",
    "partner_user_id": "<string>",
    "person_id": "<string>",
    "reward_id": "<string>",
    "reward_supplier_id": "<string>",
    "root_event_id": "<string>",
    "sandbox": "<string>"
  }
}

Authorizations

Authorization

string

header

required

Query Parameters

polling_id

string

Polling identifier returned by the reward claim call.

reward_name

string

The configured name of the reward to look up.

partner_event_id

string

The partner-supplied event identifier that originated the reward.

Response

Reward redemption status.

quality_results

object[]

required

Quality evaluation results associated with this reward redemption.

Show child attributes

reward

object

required

Show child attributes

status

enum<string>

required

Current processing status of the reward redemption (PENDING, SUCCEEDED, or FAILED).

Available options:

FAILED,

PENDING,

SUCCEEDED

List referrals to the authenticated consumer Get verification email status

Getting Started

Consumer to Extole API

Server to Extole API

Management API

Management Expert API

Get reward redemption status

Authorizations

Query Parameters

Response