Skip to main content
GET
/
api
/
loyalty
/
rules
/
status
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 response = await client.loyalty.rules.getStatus();

console.log(response.data);
{
  "data": [
    {
      "loyaltyRuleId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "status": "pending",
      "message": "<string>",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "websiteId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "progress": 50,
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "fulfilledAt": "2023-11-07T05:31:56Z"
    }
  ]
}

Authorizations

​
X-API-KEY
string
header
required

Query Parameters

​
websiteId
string<uuid>
​
organizationId
string<uuid>
​
userId
string<uuid>
​
userGroupId
string<uuid>
​
loyaltyRuleId

Unique identifier for the loyalty rule[s]

Example:

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

​
walletAddress
string
​
limit
number | null
default:10

Number of items to return

Required range: x <= 100
Example:

10

​
startingAfter
string

Starting after item

Example:

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

Response

200

​
data
object[]
required