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
Get websites
Returns a list of websites. Includes optional query parameters for filtering and pagination.
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 websites = await client.websites.list();
console.log(websites.data);
}
main();
{
"data": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "My Website",
"termsSignedAt": "2023-10-01T12:00:00Z",
"collections": [
{
"id": "123e4567-e89b-12d3-a456-426614174002",
"name": "Art Collection",
"imageUrl": "https://example.com/image.png",
"royaltyFee": 5,
"royaltyFeeAddress": "0xabc123..."
}
],
"_count": {
"mintingContractAssets": 42
}
}
],
"hasNextPage": true
}
Authorizations
Query Parameters
Pagination cursor, start after this ID
"123e4567-e89b-12d3-a456-426614174000"
Number of items to return
1 <= x <= 1000
10
Filter by organization ID
"123e4567-e89b-12d3-a456-426614174001"
Filter by name
"My Website"
Response
Response schema for fetching websites
Array of websites
Schema representing a website
Website ID
"123e4567-e89b-12d3-a456-426614174000"
Website name
"My Website"
Date when terms were signed
"2023-10-01T12:00:00Z"
Collections associated with the website
Schema representing a collection
Collection ID
"123e4567-e89b-12d3-a456-426614174002"
Collection name
"Art Collection"
URL of the collection image
"https://example.com/image.png"
Royalty fee percentage
5
Address to receive royalty fees
"0xabc123..."
Indicates if more pages are available
true
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 websites = await client.websites.list();
console.log(websites.data);
}
main();
{
"data": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "My Website",
"termsSignedAt": "2023-10-01T12:00:00Z",
"collections": [
{
"id": "123e4567-e89b-12d3-a456-426614174002",
"name": "Art Collection",
"imageUrl": "https://example.com/image.png",
"royaltyFee": 5,
"royaltyFeeAddress": "0xabc123..."
}
],
"_count": {
"mintingContractAssets": 42
}
}
],
"hasNextPage": true
}