Skip to content

Users

users_users_get

Fetch one end user of this product by id, including their identifiers and metadata bags.

Tool

users_users_get

Fetch one end user of this product by id, including their identifiers and metadata bags.

Fetch one end user of this product by id, including their identifiers and metadata bags. Soft-deleted users are still returned (with `deletedAt` set).

Behavior

HTTP
GET /users/users/:userId

Arguments

NameTypeRequiredDescription
userIdstringThe opaque user id returned by users_users_create or _list.

Response

FieldTypeAlwaysDescription
idstring
namestring
bannedAtstring
erasedAtstring
imageUrlstring
testUserboolean
createdAtstring
deletedAtstring
productIdstring
updatedAtstring
waitlistedboolean
identifiersarray
lockedUntilstring
lastSignInAtstring
requiresResetboolean
publicMetadataobject
unsafeMetadataobject
privateMetadataobject
emailChangeLockedUntilstring

Try it

Fetch one end user of this product by id, including their identifiers and metadata bags.

When to use

Fetch one end user of this product by id, including their identifiers and metadata bags. Soft-deleted users are still returned (with `deletedAt` set).

Example

Ask your agent something like this:

Fetch one end user of this product by id, including their identifiers and metadata bags.

The agent will invoke users_users_get with these arguments:

{
  "userId": "<userId>"
}

Esc

Start typing to search the docs.

navigateselect