Get users

Authorizations

X-API-KEY

string

header

required

Query Parameters

websiteId

string

The ID of the website

organizationId

string

The ID of the organization

walletAddress

string

The wallet address of the user

startingAfter

string

Pagination cursor to start after a specific user ID

limit

integer | null

Number of users to return

twitterUser

string

Twitter username of the user

discordUser

string

Discord username of the user

steamUsername

string

Steam username of the user

telegramUsername

string

Telegram username of the user

includeFollow

boolean | null

default:

false

Whether to include followers in the response

includeDelegation

boolean | null

default:

false

Whether to include delegations in the response

userGroupId

string

The ID of the user group

userGroupExternalIdentifier

string

External identifier for the user group controlled by you

address

string

The address of the user

userId

string

The ID of the user

includeUserWallet

boolean | null

default:

false

Whether to include user wallets in the response

Response

200 - application/json

data

object[]

required

Schema for users response

data.id

string

required

data.isSnagSuperAdmin

boolean

required

data.walletAddress

string

required

data._count

object | null

The followers of the user, only returned if includeFollow is true

data.delegationsFrom

object[] | null

The delegations from the user, only returned if includeDelegation is true

data.followers

object[] | null

The followers of the user, only returned if includeFollow is true and the user is querying their own user

data.notifications

boolean

Whether the user has notifications enabled, only returned if includeNotifications is true

data.privyUserId

string | null

data.stardustProfileId

string | null

data.temporaryLoyaltyUser

boolean | null

data.userMetadata

object[] | null

API Documentation

Assets

Identity

Loyalty

Loyalty Badges

User Badges

Auctions

Websites

Questions

Questions Responses

Authorizations

Query Parameters

Response