Users

users_users_list

List the end users of this product, newest first.

Tool

users_users_list

List the end users of this product, newest first.

List the end users of this product, newest first. Filter by an identifier/name substring and by status. Soft-deleted users are hidden unless `includeDeleted` is true. Paginate with the opaque `nextCursor`.

Behavior

HTTP: GET /users/users

Arguments

Name	Type	Required	Description
limit	string	—	Page size, 1-100. Default 25.
query	string	—	Case-insensitive substring match against the user's identifiers (email) and name.
cursor	string	—	Opaque cursor from a previous response's `nextCursor`. Omit for the first page.
status	string	—	Filter by status: 'active' (not banned, not waitlisted), 'banned', or 'waitlisted'. Omit for all.
includeDeleted	boolean	—	Include soft-deleted users. Default false — deleted users are hidden.
includeTestUsers	boolean	—	Include TEST USERS. Default false: a test user is a fixture, not a customer — it is excluded from metering and from this listing for the same reason. Ask for it explicitly when you are debugging the fixtures themselves.
includeWaitlisted	boolean	—	Include waitlist signups. Default false: a waitlisted row is somebody who ASKED to join and cannot sign in, so it is not part of the directory an operator browses. Use `status: "waitlisted"` to see only them, or `users_waitlist_list` for the funnel.

Response

Field	Type	Always	Description
users	array	•
nextCursor	string	•

Try it

List the end users of this product, newest first.

When to use

Example

Ask your agent something like this:

List the end users of this product, newest first.

The agent will invoke users_users_list with these arguments:

{}