Delete User | Gradii API Documentation

curl -X DELETE https://gradii.ai/api/v2/users/delete \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "userId": "user-uuid",
  "confirm": true,
  "reason": "Employee left the company",
  "transferOwnershipTo": "another-user-uuid"
}'

{
  "success": true,
  "data": {
    "deletedUser": {
      "id": "user-uuid",
      "email": "john@example.com",
      "firstName": "John",
      "lastName": "Doe"
    },
    "deletion": {
      "timestamp": "2024-01-28T10:00:00.000Z",
      "reason": "Employee left the company",
      "transferOwnershipTo": "another-user-uuid"
    },
    "company": {
      "id": "company-uuid",
      "name": "Acme Corp"
    }
  },
  "message": "User deleted successfully",
  "timestamp": "2024-01-28T10:00:00Z",
  "version": "2.0"
}

Delete a user from your company. Requires confirmation for safety. Can also use POST method.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This action cannot be undone All user data will be permanently deleted Transfer ownership before deletion if user owns important resources User must belong to your company Transfer user must be active and in the same company

userIdstringRequiredformat: "uuid"

User ID to delete

confirmbooleanRequired

Must be true to confirm deletion (safety measure)

reasonstringOptional

Reason for deletion (max 500 chars, for audit)

transferOwnershipTostringOptionalformat: "uuid"

User ID to transfer ownership to (must be active)

Response

User deleted successfully

successboolean

dataobject

messagestring

timestampstring

versionstring

Errors

400

Bad Request Error

403

Forbidden Error

404

Not Found Error