Get loyalty currencies

GEThttps://admin.snagsolutions.io/api/loyalty/currencies

Loading code example

Loading code example

Authorizations

apiKeyAuthstringheaderrequired

API key passed in the header.

Query Parameters

organizationIdstring<uuid>required

Unique identifier for the organization

websiteIdstring<uuid>required

Unique identifier for the website

startingAfterstring<uuid>

Cursor for pagination; start after this ID

includeDeletedstring

Whether to include deleted currencies

excludeTokenRewardCurrenciesstring

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.

limitinteger

Maximum number of records to return

Required range: x >= 1, x <= 1000

Response

application/json

200

dataarray<object>required

data.idstring<uuid>required

Unique identifier for the loyalty currency

data.organizationIdstring<uuid>required

Unique identifier for the organization

data.websiteIdstring<uuid>required

Unique identifier for the website

data.imageUrlstringrequired

URL of the image

data.namestringrequired

Name of the loyalty currency

data.symbolstringrequired

Symbol representing the loyalty currency

data.decimalsnumberrequired

Number of decimal places for the currency

Required range: x >= 0

data.createdByIdstring<uuid>required

ID of the user who created the currency

data.createdAtstring<date-time>required

Timestamp when the currency was created

data.updatedAtstring<date-time>required

Timestamp when the currency was last updated

data.apiGetUrlstringrequired

API GET URL for fetching data

data.apiGetTransactionEntryUrlstringrequired

API GET URL for fetching transaction entry data

data.apiPostUrlstringrequired

API POST URL for sending data

data.apiAuthType"none" | "basic" | "bearer" | "apiKey"required

Type of authentication used for API

Allowed values: "none" | "basic" | "bearer" | "apiKey"

data.apiAuthKeystringrequired

Authentication key for API

data.apiAuthValuestringrequired

Authentication value for API

data.sortIdnumberrequired

Sorting identifier

data.deletedAtstring<date-time>required

Timestamp when the currency was deleted, if applicable

data.isTokenRewardCurrencyboolean

True for LoyaltyCurrency rows auto-created by resolveTokenReward (Option 1 hidden currency backing a token-reward rule). Excluded from list responses by default; opt in via excludeTokenRewardCurrencies=false on the list endpoint.

hasNextPagebooleanrequired

GET /api/loyalty/currencies — query parameters: organizationId, websiteId, startingAfter, includeDeleted, excludeTokenRewardCurrencies, limit