Delete Users

Connecteam's API allows you to permanently delete users from the system. Unlike archiving, this action is irreversible and should be used with caution.

🚧

Important Warning

Permanent deletion cannot be undone. Once a user is deleted, their data cannot be recovered. We recommend archiving users instead unless permanent deletion is specifically required for compliance or data retention policies.

Delete User Endpoint

DELETE /users/v1/users/{userId}?deletionType=delete

Query Parameters

Restrictions

Before deleting a user, be aware of these restrictions:

• Cannot delete yourself - Admins cannot delete their own account
• Cannot delete owners - Users with owner permissions cannot be deleted via API
• Cannot delete archived users - If a user is already archived, you must unarchive them first before permanent deletion

Example Request

curl -X DELETE \
  'https://api.connecteam.com/users/v1/users/123456?deletionType=delete' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Success Response (200)

{
  "requestId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "data": {
    "count": 1
  }
}

Error Responses

What Happens When a User is Deleted

1. User is first archived (if not already)
2. User is permanently marked as deleted
3. USER_DELETED webhook is triggered
4. User is logged out from all devices
5. Manager permissions are removed (if applicable)
6. Benefits tokens are restored to the company

Delete user API reference