Get a list of deleted users that should be purged from the system

Published on Aug 7, 2026

Get

/v{version}/Users/ReadyForPurge

Security

API Key: api_key

Header parameter nameX-ApiKey

Api Key

API Key: session_id

Header parameter nameX-Session-Id

Session Id

Path parameters

version

stringRequired

The requested API version

Responses

200

OK

Array of object

object

User that will be purged

DeletedDateUtc

string (date-time)

Date in which the user is deleted in UTC

Example2022-10-14T14:23:17Z

Id

integer (int32)

Unique ID of the user

Example63

Username

string

Unique username of the user

ExampleJohnDoe

400

Bad request

Expand All

object

ValidationErrors

object

property*

Array of string additionalProperties

string

401

Unauthorized

Expand All

object

Id

string

Message

string

Type

string

Values

object

property*

object additionalProperties

403

Access denied

Expand All

object

Id

string

Message

string

Type

string

Values

object

property*

object additionalProperties

500

Unexpected error

Expand All

object

Id

string

Message

string

Type

string

Values

object

property*

object additionalProperties