Get all users for an environment

GET

environments

{environmentId}

users

Authorizations

Authorization

string

headerrequired

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

Query Parameters

filter

object

orderBy

string

$COLUMN_NAME-asc|desc

offset

integer

default: 0

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

Required range: x > 0

limit

integer

default: 20

The numbers of items to return

Required range: 1 < x < 100

Response

200 - application/json

count

integer

users

object[]

users.id

string

required

Required string length: 36

users.projectEnvironmentId

string

required

Required string length: 36

users.verifiedCredentials

object[]

users.verifiedCredentials.address

string

Valid blockchain wallet address, must be an alphanumeric string without any special characters

Maximum length: 255

users.verifiedCredentials.chain

string

users.verifiedCredentials.refId

string

Required string length: 36

users.verifiedCredentials.signerRefId

string

Required string length: 36

users.verifiedCredentials.email

string

users.verifiedCredentials.id

string

required

Required string length: 36

users.verifiedCredentials.name_service

object

users.verifiedCredentials.public_identifier

string

This is used to publicly identify a verified credential in a human-friendly way. For example, this will be the email address if credential format=email.

users.verifiedCredentials.wallet_name

string

users.verifiedCredentials.wallet_provider

enum<string>

Available options:

browserExtension,

custodialService,

walletConnect,

qrCode,

deepLink,

embeddedWallet,

smartContractWallet

users.verifiedCredentials.wallet_properties

object

users.verifiedCredentials.format

enum<string>

required

Available options:

blockchain,

email,

oauth,

passkey,

phoneNumber,

externalUser

users.verifiedCredentials.oauth_provider

enum<string>

Available options:

emailOnly,

magicLink,

apple,

bitbucket,

coinbasesocial,

discord,

facebook,

farcaster,

github,

gitlab,

google,

instagram,

linkedin,

microsoft,

twitch,

twitter,

blocto,

banxa,

dynamic,

alchemy,

zerodev,

telegram,

turnkey,

coinbaseWaas,

sms

users.verifiedCredentials.oauth_username

string

users.verifiedCredentials.oauth_display_name

string | null

users.verifiedCredentials.oauth_account_id

string | null

users.verifiedCredentials.phoneNumber

string

This field contains the phone number in the country. This could also contain the area code within a country.

users.verifiedCredentials.phoneCountryCode

string

This field contains the phone international country code. See https://countrycode.org/

users.verifiedCredentials.isoCountryCode

string

ISO-3166 two-character country code. See https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes

users.verifiedCredentials.oauth_account_photos

string[]

users.verifiedCredentials.oauth_emails

string[]

users.verifiedCredentials.oauth_metadata

object

This object contains JSON metadata for a social-based verified credential. It may contain data about the user that does not fit into the other structured fields, and could include arbitrary fields about the user from the oauth provider's API.

users.verifiedCredentials.previous_users

string[]

This will only be provided in the responses for GET /users/{userId}.Previous user IDs that owned this verified credential and was tranfered to the current user ID.

users.verifiedCredentials.embedded_wallet_id

string | null

users.verifiedCredentials.wallet_additional_addresses

object[]

users.verifiedCredentials.lastSelectedAt

string

This timestamp indicates the last time this verified wallet was either connected to the user account or selected to become the primary wallet on the account.

users.lastVerifiedCredentialId

string

Required string length: 36

users.sessionId

string

Required string length: 36

users.alias

string | null

Maximum length: 255

users.country

string | null

Standard ISO 3166-1 alpha-2 two-letter country code

Maximum length: 255

users.email

string | null

Maximum length: 255

users.firstName

string | null

Maximum length: 255

users.jobTitle

string | null

Maximum length: 255

users.lastName

string | null

Maximum length: 255

users.phoneNumber

string | null

Maximum length: 255

users.tShirtSize

string | null

Maximum length: 255

users.team

string | null

Maximum length: 255

users.username

string | null

Maximum length: 255

users.firstVisit

string

users.lastVisit

string

users.newUser

boolean

users.metadata

object

users.mfaBackupCodeAcknowledgement

enum<string> | null

Available options:

pending,

complete

users.btcWallet

string | null

users.kdaWallet

string | null

users.ltcWallet

string | null

users.ckbWallet

string | null

users.kasWallet

string | null

users.dogeWallet

string | null

users.emailNotification

boolean | null

users.discordNotification

boolean | null

users.lists

string[]

Access lists evaluated by Dynamic when considering access for the user.

users.scope

string

A whitespace-separate list of permissions associated with the JWT token issued. This conforms to the JWT standard for scope claims: https://datatracker.ietf.org/doc/html/rfc8693#section-4.2

users.missingFields

object[]

users.walletPublicKey

string

users.wallet

string

users.chain

enum<string>

Available options:

ETH,

EVM,

FLOW,

SOL,

ALGO,

STARK,

COSMOS,

BTC

users.createdAt

string

users.updatedAt

string

users.sessions

object[]

users.wallets

object[]

users.chainalysisChecks

object[]

users.oauthAccounts

object[]

users.mfaDevices

object[]

Was this page helpful?

Delete user Get a user by Id

Rest API

Authorizations

Path Parameters

Query Parameters

Response