List person rewards

curl --request GET \
  --url https://api.extole.io/v5/persons/{person_id}/rewards \
  --header 'Authorization: <api-key>'

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

fetch('https://api.extole.io/v5/persons/{person_id}/rewards', 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://api.extole.io/v5/persons/{person_id}/rewards",
  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://api.extole.io/v5/persons/{person_id}/rewards"

	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://api.extole.io/v5/persons/{person_id}/rewards")

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

[
  {
    "campaign_id": "<string>",
    "container": "<string>",
    "created_date": "2025-10-24T02:00:00-07:00",
    "data": {},
    "earned_date": "2025-10-24T02:00:00-07:00",
    "expiry_date": "2025-10-24T02:00:00-07:00",
    "face_value": 123,
    "id": "<string>",
    "journey_key": {
      "name": "<string>",
      "value": "<string>"
    },
    "journey_name": "<string>",
    "name": "<string>",
    "partner_reward_id": "<string>",
    "partner_reward_supplier_id": "<string>",
    "program": "<string>",
    "redeemed_date": "2025-10-24T02:00:00-07:00",
    "reward_supplier_id": "<string>",
    "sandbox": "<string>",
    "tags": [
      "<string>"
    ],
    "updated_date": "2025-10-24T02:00:00-07:00",
    "value_of_rewarded_event": 123
  }
]

GET

persons

{person_id}

rewards

List person rewards

curl --request GET \
  --url https://api.extole.io/v5/persons/{person_id}/rewards \
  --header 'Authorization: <api-key>'

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

fetch('https://api.extole.io/v5/persons/{person_id}/rewards', 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://api.extole.io/v5/persons/{person_id}/rewards",
  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://api.extole.io/v5/persons/{person_id}/rewards"

	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://api.extole.io/v5/persons/{person_id}/rewards")

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

[
  {
    "campaign_id": "<string>",
    "container": "<string>",
    "created_date": "2025-10-24T02:00:00-07:00",
    "data": {},
    "earned_date": "2025-10-24T02:00:00-07:00",
    "expiry_date": "2025-10-24T02:00:00-07:00",
    "face_value": 123,
    "id": "<string>",
    "journey_key": {
      "name": "<string>",
      "value": "<string>"
    },
    "journey_name": "<string>",
    "name": "<string>",
    "partner_reward_id": "<string>",
    "partner_reward_supplier_id": "<string>",
    "program": "<string>",
    "redeemed_date": "2025-10-24T02:00:00-07:00",
    "reward_supplier_id": "<string>",
    "sandbox": "<string>",
    "tags": [
      "<string>"
    ],
    "updated_date": "2025-10-24T02:00:00-07:00",
    "value_of_rewarded_event": 123
  }
]

Authorizations

Authorization

string

header

required

Path Parameters

person_id

string

required

The Extole unique profile identifier of this user at Extole.

Query Parameters

programs

string[]

campaign_ids

string[]

containers

string[]

data_keys

string[]

data_values

string[]

reward_types

enum<string>[]

Available options:

CUSTOM_REWARD,

MANUAL_COUPON,

PAYPAL_PAYOUTS,

SALESFORCE_COUPON,

TANGO_V2

reward_states

enum<string>[]

Available options:

CANCELED,

EARNED,

FAILED,

FULFILLED,

REDEEMED,

REVOKED,

SENT

offset

integer<int32>

limit

integer<int32>

journey_names

string[]

journey_key_names

string[]

journey_key_values

string[]

Response

Successful response

campaign_id

string

required

Extole campaign id associated with this reward.

container

string

required

Campaign container the reward belongs to.

created_date

string

required

RFC 3339 or RFC 9557 date-time with a numeric UTC offset and an optional IANA time-zone suffix in square brackets. Precision up to milliseconds.

Pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{1,3})?(Z|[+-](?:[01][0-9]|2[0-3]):[0-5][0-9])(\[[^\]]+\])?$

Example:

"2025-10-24T02:00:00-07:00"

data

object

required

Named data parameters attached to this reward.

Show child attributes

earned_date

string

required

RFC 3339 or RFC 9557 date-time with a numeric UTC offset and an optional IANA time-zone suffix in square brackets. Precision up to milliseconds.

Pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{1,3})?(Z|[+-](?:[01][0-9]|2[0-3]):[0-5][0-9])(\[[^\]]+\])?$

Example:

"2025-10-24T02:00:00-07:00"

expiry_date

string

required

RFC 3339 or RFC 9557 date-time with a numeric UTC offset and an optional IANA time-zone suffix in square brackets. Precision up to milliseconds.

Pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{1,3})?(Z|[+-](?:[01][0-9]|2[0-3]):[0-5][0-9])(\[[^\]]+\])?$

Example:

"2025-10-24T02:00:00-07:00"

face_value

number

required

Monetary or point face value of the reward.

face_value_type

enum<string>

required

Unit type of the face value (e.g. CASH, POINTS, PERCENT).

Available options:

AUD,

BRL,

CAD,

CNY,

EUR,

GBP,

HKD,

INR,

JPY,

KRW,

MONTH,

MXN,

NZD,

PERCENT_OFF,

POINTS,

TRY,

TWD,

USD

string

required

read-only

Extole-assigned unique identifier for this reward.

journey_key

object

required

Show child attributes

journey_name

string

required

Name of the journey associated with this reward.

name

string

required

Display name of the reward.

partner_reward_id

string

required

Partner-assigned identifier for this reward at the partner's system.

partner_reward_supplier_id

string

required

Partner-assigned identifier for the reward supplier.

program

string

required

Program key under which the reward was issued.

redeemed_date

string

required

RFC 3339 or RFC 9557 date-time with a numeric UTC offset and an optional IANA time-zone suffix in square brackets. Precision up to milliseconds.

Pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{1,3})?(Z|[+-](?:[01][0-9]|2[0-3]):[0-5][0-9])(\[[^\]]+\])?$

Example:

"2025-10-24T02:00:00-07:00"

reward_supplier_id

string

required

Extole reward supplier id that issued this reward.

sandbox

string

required

Sandbox identifier for this reward.

state

enum<string>

required

Current lifecycle state of the reward.

Available options:

CANCELED,

EARNED,

FAILED,

FULFILLED,

REDEEMED,

REVOKED,

SENT

Getting Started

Consumer to Extole API

Server to Extole API

Management API

Management Expert API

List person rewards

Authorizations

Path Parameters

Query Parameters

Response