API Documentation
Identity
- POSTCreate user device
- GETGet user metadata
- POSTCreate user metadata
- GETGet users
- GETUser count
- POSTConnect a user to User Group
- POSTDisconnect a user from User Group
- GETConnect Auth
- POSTPost apiusersverify
- GETGet all website user attributes
- POSTCreate a new website user attribute
- DELDelete a website user attribute
- GETGet all website user attribute values
- POSTCreate a new website user attribute value
Loyalty
- GETGet loyalty accounts
- GETGet the rank of a user based on their loyalty points
- GETGet loyalty currencies
- POSTCreate a loyalty currency
- GETGet Loyalty Multipliers
- POSTCreate Loyalty Multiplier
- DELDelete Loyalty Multiplier by External Identifier
- POSTUpdate Loyalty Multiplier
- DELDelete Loyalty Multiplier by ID
- GETGet Loyalty Rule Edits
- POSTRestore Loyalty Rule Edit
- GETGet Loyalty Rule Groups
- POSTCreate Loyalty Rule Groups
- POSTUpdate Loyalty Rule Group
- DELDelete Loyalty Rule Group
- GETGet Loyalty Rules
- POSTCreate Loyalty Rule
- POSTUpdate Loyalty Rule
- DELDelete Loyalty Rule
- POSTComplete Loyalty Rule
- GETGet Processing status for a specific user on loyalty rules
- POSTCreate Loyalty Transaction
- GETGet Loyalty Transaction Entries
- GETGet Loyalty Rule Chains
- GETGet Loyalty Rule Statuses
- POSTUpdate Loyalty Rule Status
Badge
Minting
Question
Website
Landing Page
Loyalty
Get loyalty currencies
Get loyalty currencies
GET
/
api
/
loyalty
/
currencies
import SnagSolutions from '@snagsolutions/sdk';
const client = new SnagSolutions({
apiKey: process.env['X_API_KEY'], // This is the default and can be omitted
});
async function main() {
const currencies = await client.loyalty.currencies.list({
organizationId: '123e4567-e89b-12d3-a456-426614174001',
websiteId: '123e4567-e89b-12d3-a456-426614174002',
});
console.log(currencies.data);
}
main();
{
"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
Query Parameters
Unique identifier for the organization
Example:
"123e4567-e89b-12d3-a456-426614174001"
Unique identifier for the website
Example:
"123e4567-e89b-12d3-a456-426614174002"
Cursor for pagination; start after this ID
Example:
"123e4567-e89b-12d3-a456-426614174010"
Whether to include deleted currencies
Example:
"false"
Maximum number of records to return
Required range:
1 <= x <= 1000
Example:
50
Response
200
application/json
200
The response is of type object
.
Was this page helpful?
import SnagSolutions from '@snagsolutions/sdk';
const client = new SnagSolutions({
apiKey: process.env['X_API_KEY'], // This is the default and can be omitted
});
async function main() {
const currencies = await client.loyalty.currencies.list({
organizationId: '123e4567-e89b-12d3-a456-426614174001',
websiteId: '123e4567-e89b-12d3-a456-426614174002',
});
console.log(currencies.data);
}
main();
{
"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
}
Assistant
Responses are generated using AI and may contain mistakes.