---
title: "Get reward state history"
method: GET
path: "/v2/rewards/{reward_id}/history"
tags: ["Rewards"]
---

# Get reward state history

`GET /v2/rewards/{reward_id}/history`

## Request

- Base URL: `https://api.extole.io`
- URL: `https://api.extole.io/v2/rewards/{reward_id}/history`
- Auth: one of:
  - API key in header `Authorization`
  - API key in query parameter `access_token`
  - API key in cookie `extole_token`
- TypeScript: <https://skmtc.dev/extole/apis/integration-api-server-to-extole/docs/v2/rewards/:reward_id/history/get.ts> (a function with typed inputs; its response is checked against the schema)

Returns the full state-transition history for the specified reward.

## Path parameters

- `reward_id` string, required

## Response `200`

Successful response

- RewardStateResponse[]
  - `created_at` string, required: [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) or [RFC 9557](https://datatracker.ietf.org/doc/html/rfc9557#section-4) date-time with a numeric [UTC offset](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and an optional [IANA time-zone](https://datatracker.ietf.org/doc/html/rfc9557#section-4) suffix in square brackets. Precision up to milliseconds.
  - `message` string, required: Human-readable message associated with this state transition.
  - `operator_user_id` string, required: Extole user id of the operator who triggered this state transition, if applicable.
  - `state_type` 'CANCELED' | 'EARNED' | 'FAILED' | 'FULFILLED' | 'REDEEMED' | 'REVOKED' | 'SENT', required: Lifecycle state type of this reward state transition.
  - `success` boolean, required: Whether this state transition was successful.

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `402`: Payment Required
- `403`: Forbidden
- `415`: Unsupported Media Type
- `429`: Too Many Requests

---

[API](https://skmtc.dev/extole/apis/integration-api-server-to-extole.md) - [All operations](https://skmtc.dev/extole/apis/integration-api-server-to-extole/llms.txt) - [OpenAPI document](https://skmtc.dev/extole/apis/integration-api-server-to-extole/revisions/c16e62e66755?raw)