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. Page through with `nextCursor`.
Behavior
- HTTP
GET /users/users/export
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
| 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. |
Response
| Field | Type | Always | Description |
|---|---|---|---|
| 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.