Skip to main content
GET
/
api
/
loyalty
/
currencies
Get loyalty currencies
curl --request GET \
  --url https://admin.snagsolutions.io/api/loyalty/currencies \
  --header 'X-API-KEY: <api-key>'
{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174005",
      "organizationId": "123e4567-e89b-12d3-a456-426614174001",
      "websiteId": "123e4567-e89b-12d3-a456-426614174002",
      "imageUrl": "https://d1ked0nzx7in3u.cloudfront.net/images/loyalty.png",
      "name": "Loyalty Points",
      "symbol": "LP",
      "decimals": 2,
      "createdById": "123e4567-e89b-12d3-a456-426614174010",
      "createdAt": "2023-10-01T12:34:56.000Z",
      "updatedAt": "2023-10-05T15:30:00.000Z",
      "apiGetUrl": "https://api.example.com/get-loyalty",
      "apiGetTransactionEntryUrl": "https://api.example.com/get-loyalty",
      "apiPostUrl": "https://api.example.com/post-loyalty",
      "apiAuthType": "basic",
      "apiAuthKey": "apiKey123",
      "apiAuthValue": "apiValue456",
      "sortId": 1,
      "deletedAt": null,
      "isTokenRewardCurrency": false
    }
  ],
  "hasNextPage": true
}

Authorizations

​
X-API-KEY
string
header
required

Query Parameters

​
organizationId
string<uuid>
required

Unique identifier for the organization

Example:

"123e4567-e89b-12d3-a456-426614174001"

​
websiteId
string<uuid>
required

Unique identifier for the website

Example:

"123e4567-e89b-12d3-a456-426614174002"

​
startingAfter
string<uuid>

Cursor for pagination; start after this ID

Example:

"123e4567-e89b-12d3-a456-426614174010"

​
includeDeleted
string

Whether to include deleted currencies

Example:

"false"

​
excludeTokenRewardCurrencies
string

Exclude LoyaltyCurrency rows auto-created by token-reward rules (isTokenRewardCurrency=true). Defaults to true so admin pickers never see them; surfaces that need to render an existing token-reward rule pass false.

Example:

"true"

​
limit
integer

Maximum number of records to return

Required range: 1 <= x <= 1000
Example:

50

Response

200

​
data
Loyalty Currency Schema · object[]
required
​
hasNextPage
boolean
required