Delete User

This endpoint permanently deletes a user by ID. It cannot be undone.

Endpoint

DELETE /v1/users/users/:id

Authentication

Include your API key in the x-api-key header. See Authentication.

Required Scope

users:write

Path Parameters

Parameter	Type	Required	Description
id	string	Yes	User ID to delete.

Request Body

This endpoint does not accept a request body.

Example Request

cURL

curl -X DELETE "https://api.crewsum.com/v1/users/users/user-a" \
  -H "x-api-key: $CREWSUM_API_KEY"

JavaScript

const response = await fetch("https://api.crewsum.com/v1/users/users/user-a", {
  method: "DELETE",
  headers: {
    "x-api-key": process.env.CREWSUM_API_KEY,
  },
});
const result = await response.json();

HTTP

DELETE /v1/users/users/user-a HTTP/1.1
Host: api.crewsum.com
x-api-key: <your-api-key>

Response

On success, the API returns HTTP 200 OK.

Example Response

{
  "message": "Successfully deleted user"
}

Behavior

• This is a hard delete. The user record is removed from the database. It is not archived.
• Crewsum also removes the user’s direct project and task assignments, supplier contact links, and user group memberships.
• Crewsum deletes the user’s sign-in profile. If that step fails, the user is still deleted and the API still returns 200.
• Crewsum updates the number of paid seats on your subscription. This can change your bill.
• You cannot delete a user with the tenant-admin role. The API returns 500.
• The delete fails with 500 when other records still refer to the user, for example the user’s timesheets or a linked internal contact. To remove such a user from active use, archive them with Update User instead.
• An unknown user ID returns 500, not 404.
• After the user is deleted, Crewsum sends the users.deleted webhook event.

Error Responses

Status	Meaning
400	"User ID not found": the ID path segment was empty.
500	"Error deleting user": the user does not exist, has the tenant-admin role, is still referenced by other records, or the delete failed.

Authentication and scope failures are described in Errors.

Related Webhooks

users.deleted View webhook event details.