Skip to main content
GET
/
environments
/
{environmentId}
/
users
Get all users for an environment
curl --request GET \
  --url https://app.dynamicauth.com/api/v0/environments/{environmentId}/users \
  --header 'Authorization: Bearer <token>'
{
  "count": 123,
  "users": [
    {
      "id": "95b11417-f18f-457f-8804-68e361f9164f",
      "projectEnvironmentId": "95b11417-f18f-457f-8804-68e361f9164f",
      "verifiedCredentials": [
        {
          "id": "95b11417-f18f-457f-8804-68e361f9164f",
          "format": "blockchain",
          "signInEnabled": true,
          "address": "0xbF394748301603f18d953C90F0b087CBEC0E1834",
          "chain": "<string>",
          "refId": "95b11417-f18f-457f-8804-68e361f9164f",
          "signerRefId": "95b11417-f18f-457f-8804-68e361f9164f",
          "email": "jsmith@example.com",
          "name_service": {
            "avatar": "<string>",
            "name": "<string>"
          },
          "public_identifier": "<string>",
          "wallet_name": "<string>",
          "wallet_provider": "browserExtension",
          "wallet_properties": {
            "turnkeySubOrganizationId": "95b11417-f18f-457f-8804-68e361f9164f",
            "turnkeyPrivateKeyId": "95b11417-f18f-457f-8804-68e361f9164f",
            "turnkeyHDWalletId": "95b11417-f18f-457f-8804-68e361f9164f",
            "isAuthenticatorAttached": true,
            "turnkeyUserId": "95b11417-f18f-457f-8804-68e361f9164f",
            "isSessionKeyCompatible": true,
            "version": "V1",
            "ecdsaProviderType": "zerodev_signer_to_ecdsa",
            "entryPointVersion": "v6",
            "kernelVersion": "v2_4"
          },
          "oauth_provider": "emailOnly",
          "oauth_username": "<string>",
          "oauth_display_name": "<string>",
          "oauth_account_id": "<string>",
          "phoneNumber": "9171113333",
          "phoneCountryCode": "1",
          "isoCountryCode": "US",
          "oauth_account_photos": [
            "<string>"
          ],
          "oauth_emails": [
            "<string>"
          ],
          "oauth_metadata": {},
          "previous_users": [
            "95b11417-f18f-457f-8804-68e361f9164f"
          ],
          "embedded_wallet_id": "<string>",
          "wallet_additional_addresses": [
            {
              "address": "<string>",
              "type": "ordinals",
              "publicKey": "<string>"
            }
          ],
          "lastSelectedAt": "2023-11-07T05:31:56Z",
          "verifiedAt": "2023-11-07T05:31:56Z"
        }
      ],
      "lastVerifiedCredentialId": "95b11417-f18f-457f-8804-68e361f9164f",
      "sessionId": "95b11417-f18f-457f-8804-68e361f9164f",
      "alias": "An example name",
      "country": "US",
      "email": "jsmith@example.com",
      "firstName": "An example name",
      "jobTitle": "An example name",
      "lastName": "An example name",
      "phoneNumber": "<string>",
      "policiesConsent": true,
      "tShirtSize": "An example name",
      "team": "An example name",
      "username": "An example name",
      "firstVisit": "2023-11-07T05:31:56Z",
      "lastVisit": "2023-11-07T05:31:56Z",
      "newUser": true,
      "metadata": {},
      "mfaBackupCodeAcknowledgement": "pending",
      "btcWallet": "<string>",
      "kdaWallet": "<string>",
      "ltcWallet": "<string>",
      "ckbWallet": "<string>",
      "kasWallet": "<string>",
      "dogeWallet": "<string>",
      "emailNotification": true,
      "discordNotification": true,
      "newsletterNotification": true,
      "lists": [
        "<string>"
      ],
      "scope": "superuser marketing operations",
      "missingFields": [
        {
          "name": "<string>",
          "required": true,
          "enabled": true,
          "unique": true,
          "verify": true,
          "type": "standard",
          "validationRules": {
            "unique": true,
            "regex": "^0x",
            "validOptions": [
              {
                "label": "small"
              },
              {
                "label": "medium"
              },
              {
                "label": "large"
              }
            ],
            "checkboxText": "Agree to the terms and conditions"
          },
          "validationType": "text",
          "label": "<string>",
          "position": 123
        }
      ],
      "walletPublicKey": "<string>",
      "wallet": "<string>",
      "chain": "ETH",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "sessions": [
        {
          "id": "95b11417-f18f-457f-8804-68e361f9164f",
          "createdAt": "2023-11-07T05:31:56Z",
          "ipAddress": "<string>",
          "userAgent": "<string>",
          "revokedAt": "2023-11-07T05:31:56Z"
        }
      ],
      "wallets": [
        {
          "id": "95b11417-f18f-457f-8804-68e361f9164f",
          "name": "An example name",
          "chain": "ETH",
          "publicKey": "0xbF394748301603f18d953C90F0b087CBEC0E1834",
          "provider": "browserExtension",
          "properties": {
            "turnkeySubOrganizationId": "95b11417-f18f-457f-8804-68e361f9164f",
            "turnkeyPrivateKeyId": "95b11417-f18f-457f-8804-68e361f9164f",
            "turnkeyHDWalletId": "95b11417-f18f-457f-8804-68e361f9164f",
            "isAuthenticatorAttached": true,
            "turnkeyUserId": "95b11417-f18f-457f-8804-68e361f9164f",
            "isSessionKeyCompatible": true,
            "version": "V1",
            "ecdsaProviderType": "zerodev_signer_to_ecdsa",
            "entryPointVersion": "v6",
            "kernelVersion": "v2_4"
          },
          "lastSelectedAt": "<string>"
        }
      ],
      "chainalysisChecks": [
        {
          "id": "95b11417-f18f-457f-8804-68e361f9164f",
          "createdAt": "2023-11-07T05:31:56Z",
          "result": "OK",
          "walletPublicKey": "0xbF394748301603f18d953C90F0b087CBEC0E1834",
          "response": "<string>"
        }
      ],
      "oauthAccounts": [
        {
          "id": "95b11417-f18f-457f-8804-68e361f9164f",
          "provider": "emailOnly",
          "accountUsername": "<string>"
        }
      ],
      "mfaDevices": [
        {
          "type": "totp",
          "verified": true,
          "id": "95b11417-f18f-457f-8804-68e361f9164f",
          "createdAt": "2023-11-07T05:31:56Z",
          "verifiedAt": "2023-11-07T05:31:56Z",
          "default": true,
          "alias": "<string>"
        }
      ]
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.dynamic.xyz/docs/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

environmentId
string
required

ID of the environment

Required string length: 36
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
Example:

"95b11417-f18f-457f-8804-68e361f9164f"

Query Parameters

filter
object

JSON-encoded filter object with filterColumn (e.g. email, walletPublicKey, all) and filterValue

orderBy
string

Sort order as "column-direction" (e.g. email-asc, createdAt-desc) — supported columns: alias, createdAt, email, firstName, id, lastName, lastVisit $COLUMN_NAME-asc|desc

Pattern: ^[A-Za-z]*-(asc|desc)$
Example:

"something-asc"

offset
integer
default:0

The number of items to skip before starting to collect the result set. Maximum of 10,000 — use the export feature for larger datasets.

Required range: 0 <= x <= 10000
limit
integer
default:20

The numbers of items to return

Required range: 1 <= x <= 100
includeSessions
boolean

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

Response

List of users

count
integer

Total number of users matching the query

users
object[]

List of user objects