• Example searches: “transaction”, “CreateOrder”, “/v2/locations”, “inventory”, “delete customer”

You are viewing an old version of the API
Retrieve loyalty reward

GET /v2/loyalty/rewards/{reward_id}

Retrieves a loyalty reward.

Permissions
LOYALTY_READ
Guide
Retrieve loyalty reward Try in API Explorer

Path Parameters

Example code
Name Description
reward_id
string
Required

The ID of the loyalty reward to retrieve.

Response Fields
Name Description
errors
Error [ ]

Any errors that occurred during the request.
reward
LoyaltyReward

The loyalty reward retrieved.

Examples

You are viewing an old version of the API
GET /v2/loyalty/rewards/{reward_id}
cURL
  • cURL
  • Ruby
  • Python
  • C#
  • Java
  • PHP
  • Node.js 
curl https://connect.squareup.com/v2/loyalty/rewards/9f18ac21-233a-31c3-be77-b45840f5a810 \
  -H 'Square-Version: 2023-01-19' \
  -H 'Authorization: Bearer ACCESS_TOKEN' \
  -H 'Content-Type: application/json'
Response JSON 
{
  "reward": {
    "id": "9f18ac21-233a-31c3-be77-b45840f5a810",
    "status": "REDEEMED",
    "loyalty_account_id": "5adcb100-07f1-4ee7-b8c6-6bb9ebc474bd",
    "reward_tier_id": "e1b39225-9da5-43d1-a5db-782cdd8ad94f",
    "points": 10,
    "created_at": "2020-05-08T21:55:42Z",
    "updated_at": "2020-05-08T21:56:00Z",
    "redeemed_at": "2020-05-08T21:56:00Z"
  }
}