Sign in
User

Delete Expired Users

Delete cleanup-target users in the specified scope.

  • target: expired | limited | on_hold | disabled
  • expired_after / expired_before UTC datetime (optional)
  • For expired: filters by expiration date.
  • For limited / on_hold / disabled: filters by last_status_change (when they entered that status).
  • dry_run: if true, returns users that would be deleted without deleting them.
delete/api/users/expired

Query parameters

admin_usernamestring nullable
target'expired' | 'limited' | 'on_hold' | 'disabled'
expired_afterstring date-time nullable
Example:2024-01-01T00:00:00+03:30
expired_beforestring date-time nullable
Example:2024-01-31T23:59:59+03:30
dry_runboolean

Response

Successful Response

usersstring[] required
countinteger required

Changes

No recorded changes to this endpoint across all 1 revision of this API.