GET
/
api
/
users
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 users = await client.users.list();

  console.log(users.data);
}

main();
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "temporaryLoyaltyUser": true,
      "isSnagSuperAdmin": true,
      "walletAddress": "<string>",
      "stardustProfileId": "<string>",
      "privyUserId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "notifications": true,
      "delegationsFrom": [
        {
          "walletAddress": "<string>"
        }
      ],
      "userMetadata": [
        {
          "emailAddress": "<string>",
          "emailVerifiedAt": "<string>",
          "discordUser": "<string>",
          "discordVerifiedAt": "<string>",
          "twitterUser": "<string>",
          "twitterVerifiedAt": "<string>",
          "instagramUser": "<string>",
          "instagramVerifiedAt": "<string>",
          "logoUrl": "<string>",
          "displayName": "<string>",
          "location": "<string>",
          "bio": "<string>",
          "portfolioUrl": "<string>",
          "meta": "<string>",
          "userGroupId": "<string>",
          "walletGroupIdentifier": "<string>",
          "twitterUserFollowersCount": 123,
          "telegramUserId": "<string>",
          "telegramVerifiedAt": "<string>",
          "telegramUsername": "<string>",
          "isBlocked": true,
          "steamUserId": "<string>",
          "steamUsername": "<string>",
          "epicUsername": "<string>",
          "epicAccountIdentifier": "<string>"
        }
      ],
      "followers": [
        {
          "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        }
      ],
      "_count": {
        "select": {
          "followers": 123,
          "follows": 123
        }
      }
    }
  ]
}

Authorizations

X-API-KEY
string
header
required

Query Parameters

websiteId
string

The ID of the website

Example:

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

organizationId
string

The ID of the organization

Example:

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

walletAddress
string

The wallet address of the user

Example:

"0x1234567890abcdef1234567890abcdef12345678"

startingAfter
string

Pagination cursor to start after a specific user ID

Example:

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

limit
integer

Number of users to return

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

10

twitterUser
string

Twitter username of the user

Example:

"elonmusk"

discordUser
string

Discord username of the user

Example:

"elonmusk"

steamUsername
string

Steam username of the user

Example:

"elonmusk"

steamUserId
string

Steam ID of the user

Example:

"1234567890"

telegramUsername
string

Telegram username of the user

Example:

"elonmusk"

telegramUserId
string

Telegram ID of the user

Example:

"1234567890"

includeFollow
boolean | null
default:false

Whether to include followers in the response

Example:

true

includeDelegation
boolean | null
default:false

Whether to include delegations in the response

Example:

true

userGroupId
string

The ID of the user group

Example:

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

userGroupExternalIdentifier
string

External identifier for the user group controlled by you

externalIdentifier
string

External identifier for the user

Example:

"123e4567"

address
string

The address of the user

Example:

"0x1234567890abcdef1234567890abcdef12345678"

userId

The ID of the user

Example:

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

Response

200
application/json
200
data
object[]
required

Schema for users response

Schema for a user response