GET
/
api
/
loyalty
/
currencies
JavaScript
import SnagSolutions from '@snagsolutions/sdk';

const client = new SnagSolutions({
  apiKey: process.env['X_API_KEY'], // This is the default and can be omitted
});

const currencies = await client.loyalty.currencies.list({
  organizationId: '123e4567-e89b-12d3-a456-426614174001',
  websiteId: '123e4567-e89b-12d3-a456-426614174002',
});

console.log(currencies.data);
{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174005",
      "organizationId": "123e4567-e89b-12d3-a456-426614174001",
      "websiteId": "123e4567-e89b-12d3-a456-426614174002",
      "imageUrl": "https://assets.snagsolutions.io/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
    }
  ],
  "hasNextPage": true
}

Authorizations

​
X-API-KEY
string
header
required

Query Parameters

​
organizationId
string
required

Unique identifier for the organization

Example:

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

​
websiteId
string
required

Unique identifier for the website

Example:

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

​
startingAfter
string

Cursor for pagination; start after this ID

Example:

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

​
includeDeleted
string

Whether to include deleted currencies

Example:

"false"

​
limit
integer

Maximum number of records to return

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

50

Response

200
application/json

200

The response is of type object.