Sign in

v2

latestOpenAPI 3.0.12026-07-26334612609.5 KB
Users

Get all users for an environment

get/environments/{environmentId}/users

Path parameters

environmentIdstring required
Example:95b11417-f18f-457f-8804-68e361f9164f

ID of the environment

Query parameters

filterValuestring
filterColumn'all' | 'id' | 'walletPublicKey' | 'email' | 'alias' | 'firstName' | 'lastName' | 'phoneNumber' | 'jobTitle' | 'wallet' | 'username' | 'accountId'
filterSocialProvider'emailOnly' | 'magicLink' | 'apple' | 'bitbucket' | 'coinbasesocial' | 'discord' | 'epicgames' | 'facebook' | 'farcaster' | 'github' | 'gitlab' | 'google' | 'instagram' | 'linkedin' | 'microsoft' | 'twitch' | 'twitter' | 'blocto' | 'banxa' | 'coinbaseOnramp' | 'cryptoDotCom' | 'dynamic' | 'alchemy' | 'zerodev' | 'telegram' | 'turnkey' | 'coinbaseWaas' | 'sms' | 'spotify' | 'tiktok' | 'line' | 'steam' | 'shopify' | 'zksync' | 'kraken' | 'blockaid' | 'passkey' | 'okta' | 'sendgrid' | 'resend'

The 'turnkey' value is deprecated and will be removed in a future version.

chain'ETH' | 'EVM' | 'FLOW' | 'SOL' | 'ALGO' | 'STARK' | 'COSMOS' | 'BTC' | 'ECLIPSE' | 'SUI' | 'SPARK' | 'TRON' | 'APTOS' | 'TON' | 'STELLAR'
orderBystring

$COLUMN_NAME-asc|desc

Example:something-asc
offsetinteger

The number of items to skip before starting to collect the result set

limitinteger

The numbers of items to return

includeSessionsboolean

When true, we will return the most recent list of sessions for each user in the list.

Response

List of users

countinteger

Example response

{
  "users": [
    {
      "id": "95b11417-f18f-457f-8804-68e361f9164f",
      "projectEnvironmentId": "95b11417-f18f-457f-8804-68e361f9164f",
      "verifiedCredentials": [
        {
          "address": "0xbF394748301603f18d953C90F0b087CBEC0E1834",
          "refId": "95b11417-f18f-457f-8804-68e361f9164f",
          "signerRefId": "95b11417-f18f-457f-8804-68e361f9164f",
          "id": "95b11417-f18f-457f-8804-68e361f9164f",
          "wallet_properties": {
            "turnkeySubOrganizationId": "95b11417-f18f-457f-8804-68e361f9164f",
            "turnkeyPrivateKeyId": "95b11417-f18f-457f-8804-68e361f9164f",
            "turnkeyHDWalletId": "95b11417-f18f-457f-8804-68e361f9164f",
            "turnkeyUserId": "95b11417-f18f-457f-8804-68e361f9164f"
          },
          "phoneNumber": "9171113333",
          "phoneCountryCode": "1",
          "isoCountryCode": "US",
          "previous_users": [
            "95b11417-f18f-457f-8804-68e361f9164f"
          ]
        }
      ],
      "lastVerifiedCredentialId": "95b11417-f18f-457f-8804-68e361f9164f",
      "sessionId": "95b11417-f18f-457f-8804-68e361f9164f",
      "alias": "An example name",
      "country": "US",
      "firstName": "An example name",
      "jobTitle": "An example name",
      "lastName": "An example name",
      "tShirtSize": "An example name",
      "team": "An example name",
      "username": "An example name",
      "scope": "superuser marketing operations",
      "missingFields": [
        {
          "validationRules": {
            "regex": "^0x",
            "validOptions": [
              {
                "label": "small"
              },
              {
                "label": "medium"
              },
              {
                "label": "large"
              }
            ],
            "checkboxText": "Agree to the terms and conditions"
          }
        }
      ],
      "sessions": [
        {
          "id": "95b11417-f18f-457f-8804-68e361f9164f"
        }
      ],
      "wallets": [
        {
          "id": "95b11417-f18f-457f-8804-68e361f9164f",
          "name": "An example name",
          "publicKey": "0xbF394748301603f18d953C90F0b087CBEC0E1834",
          "properties": {
            "turnkeySubOrganizationId": "95b11417-f18f-457f-8804-68e361f9164f",
            "turnkeyPrivateKeyId": "95b11417-f18f-457f-8804-68e361f9164f",
            "turnkeyHDWalletId": "95b11417-f18f-457f-8804-68e361f9164f",
            "turnkeyUserId": "95b11417-f18f-457f-8804-68e361f9164f"
          }
        }
      ],
      "chainalysisChecks": [
        {
          "id": "95b11417-f18f-457f-8804-68e361f9164f",
          "walletPublicKey": "0xbF394748301603f18d953C90F0b087CBEC0E1834"
        }
      ],
      "oauthAccounts": [
        {
          "id": "95b11417-f18f-457f-8804-68e361f9164f"
        }
      ],
      "mfaDevices": [
        {
          "id": "95b11417-f18f-457f-8804-68e361f9164f"
        }
      ]
    }
  ]
}