User

Deactivate a User

Deactivates a user. Deactivated users can no longer log in but are still returned by the API (with a non-null deactivated_at).

This endpoint is idempotent — calling it on an already-deactivated user returns 200 with no change.

⚠️ SCIM integration warning: If users in your account are managed via SCIM (e.g. from Entra ID or Okta), SCIM is the source of truth for user lifecycle. Deactivating users manually via this endpoint may conflict with your SCIM provisioning setup. Use SCIM deprovisioning to deactivate users in that case.

Note: Deleted users are not accessible and will return a 404 error.

post/users/{id}/deactivate

Request

  • Base URL: https://connect.workpath.com/api/v3
  • URL: https://connect.workpath.com/api/v3/users/{id}/deactivate
  • Auth: HTTP bearer

Response

OK

idinteger required

Unique identifier for the user.

emailstring email required

Email address of the user.

first_namestring required

First name of the user.

last_namestring required

Last name of the user.

namestring required

Full name of the user (first name + last name).

external_idstring nullable

External identifier for integration with other systems. Typically set via SAML or SCIM integration, often containing an ID from the identity provider (e.g., Entra ID object ID) or another internal employee ID. May be null if not set.

created_atstring date-time required

Timestamp when the user was created in ISO 8601 format.

updated_atstring date-time required

Timestamp when the user was last updated in ISO 8601 format.

deactivated_atstring date-time nullable

Timestamp when the user was deactivated in ISO 8601 format. null if the user is active.

last_active_atstring date-time nullable

Timestamp when the user was last active in ISO 8601 format. null if no activity has been recorded.

workpath_urlstring uri required

URL to view the user in the Workpath platform.

status'active' | 'invited' | 'deactivated' required

Mirrors the user status shown in the Workpath user settings UI (https://your-account.workpath.com/settings/users):

  • deactivated — deactivated_at is set.
  • invited — the user has an outstanding invitation and has not yet completed their first login.
  • active — otherwise.

Use status instead of deriving buckets from deactivated_at / last_active_at, so your reporting matches what end users see in Workpath.

license'standard' | 'analyst' | 'viewer' required

What the user can do in Workpath: standard users work with Goals, Key Results and Initiatives; viewer users can only view and follow them; analyst users additionally get access to reports.

rolesstring[] required

Additional responsibilities: super_admin users administer the customer's Workpath account, program_lead users run the goal-setting program, and coach users help teams draft their Goals. A user can have zero, one or several roles.

Example response

{
  "id": 5,
  "email": "thomas.weber@acme.com",
  "first_name": "Thomas",
  "last_name": "Weber",
  "name": "Thomas Weber",
  "external_id": "EMP-001",
  "created_at": "2025-01-15T10:30:00Z",
  "updated_at": "2026-01-20T14:45:00Z",
  "deactivated_at": null,
  "last_active_at": "2026-01-21T08:15:00Z",
  "workpath_url": "https://acme.workpath.com/users/5",
  "status": "active",
  "license": "standard",
  "roles": [
    "super_admin",
    "coach"
  ],
  "business_units": [
    {
      "id": 2,
      "name": "ACME EMEA"
    }
  ]
}

Changes

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