Sign in
Users

List authenticated users.

Changed on

Retrieves an authenticated users.

Users have linked accounts and are authenticated with a provider.

get/v2/users

Request

  • Base URL: https://api.openfort.io
  • URL: https://api.openfort.io/v2/users
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Query parameters

limitinteger

Specifies the maximum number of records to return.

skipinteger

Specifies the offset for the first records to return.

order'asc' | 'desc'

Specifies the order in which to sort the results.

namestring

Filter by user name.

externalUserIdstring

Filter by external user ID (accountId from linked accounts).

emailstring

Filter by user email.

phoneNumberstring

Filter by user phone number.

authProviderIdstring

Filter by provider ID (e.g., "google", "apple", "siwe", "credential").

walletClientTypestring

Filter by wallet client type (for SIWE accounts).

Response

Successful response.

object'list' required
urlstring required
startinteger required
endinteger required
totalinteger required

Changes

  • 88be7ccfca19Revision changes
    • info

      the security scope users:read was added to the endpoint's security scheme sk

  • 63216e0be364Revision changes
    • info

      added the new optional query request parameter authProviderId

    • info

      added the new optional query request parameter email

    • info

      added the new optional query request parameter phoneNumber

    • info

      added the new optional query request parameter walletClientType