users_users_export

Tool

users_users_export

Export the end users of this product as pages of full records (profile, identifiers, metadata bags), using the same filters as users_users_list.

Export the end users of this product as pages of full records (profile, identifiers, metadata bags), using the same filters as users_users_list. Password hashes are NEVER included — neither a PHC hash nor an imported foreign one. Exporting credentials is deferred to a later phase, behind explicit elevated approval; until that gating exists, a hash cannot leave this toolkit. Every call is AUDITED (action `users.export`, with the filter and the row count), so this is not a silent read: use it for migrations, backups and subject-access requests, not as a listing shortcut. Filter by `kind`, or pass `includeContacts: true`, to export accounts and contacts in one pass — contacts are excluded by default, the same rule this export already applies to waitlist signups and test users. Page through with `nextCursor`. Identifiers include contact channels (`phone`, `telegram`, `linkedin`, `x`) alongside emails; a channel is always `unverified`.

Behavior

HTTP: GET /users/users/export

Arguments

Name	Type	Required	Description
kind	string	—	Filter by kind: 'account' or 'contact'. Omit for accounts only, unless `includeContacts` is true.
limit	string	—	Rows per page, 1-500. Default 100.
query	string	—	Case-insensitive substring match against the user's identifiers (email) and name.
cursor	string	—	Opaque cursor from the previous page's `nextCursor`. Omit for the first page.
status	string	—	Filter by status: 'active', 'banned' or 'waitlisted'. Omit for all.
includeDeleted	boolean	—	Include soft-deleted users. Default false.
includeContacts	boolean	—	Include CONTACTS alongside accounts, so one pass exports both. Default false — the same rule this export already applies to waitlist signups and test users.

Response

Field	Type	Always
count	integer	•
users	array	•
exportedAt	string	•
nextCursor	string	•

Try it

Export the end users of this product as pages of full records (profile, identifiers, metadata bags), using the same filters as users_users_list.

When to use

Example

Ask your agent something like this:

Export the end users of this product as pages of full records (profile, identifiers, metadata bags), using the same filters as users_users_list.

The agent will invoke users_users_export with these arguments:

{}