Introduction

The WorkComposer Users API allows you to manage users within your organization. Use these endpoints to create, retrieve, update, delete, activate, and deactivate users programmatically.

Users are the foundation of WorkComposer's time tracking and project management capabilities. This API is particularly useful for synchronizing user accounts with your HR systems, automating user onboarding and offboarding, and maintaining consistent user data across your organization.

This endpoint returns a list of all users in your workspace or details about a specific user if a user ID is provided. The response includes user information such as ID, name, email, team, role, and status.

{
  "status": 1,
  "users": [
    {
      "id": "507f1f77bcf86cd799439011",
      "externalId": "507f1f77bcf86cd799439011",
      "firstName": "John",
      "lastName": "Doe",
      "email": "john.doe@example.com",
      "teamId": "507f191e810c19729de860ea",
      "teamName": "Engineering",
      "role": "User",
      "isActive": true,
      "createdAt": "2025-12-02T10:30:00.000Z",
      "lastSyncedAt": "2025-12-02T15:00:00.000Z"
    }
  ],
  "pagination": {
    "total": 42,
    "offset": 0,
    "limit": 25,
    "hasMore": true
  }
}

        

This endpoint invites a new user to your workspace via email. The user will receive an invitation email with a link to accept the invitation, set their first and last name, create their password, and sign in. Only users with Admin or Owner roles can invite users. The invited user will be automatically assigned the default 'User' role.

{
  "status": 1,
  "userId": "507f1f77bcf86cd799439011",
  "message": "Invitation sent successfully"
}

        

This endpoint allows you to create a new user directly with a password in your workspace. Only users with Admin or Owner roles can create users. The user will be automatically assigned the default 'User' role. You will need to securely share the password with the user after creation.

{
  "status": 1,
  "userId": "507f1f77bcf86cd799439011",
  "message": "User created successfully"
}

        

This endpoint allows you to update an existing user's details. Only users with Admin or Owner roles can update users. You only need to include the fields you want to update.

{
  "status": 1,
  "message": "User updated successfully"
}

        

This endpoint allows you to permanently delete a user from your workspace. Only users with Admin or Owner roles can delete users. Use with caution as this action cannot be undone. Note that Owner accounts cannot be deleted.

{
  "status": 1,
  "message": "User deleted successfully"
}

        

This endpoint allows you to activate (unarchive) a deactivated user. Only users with Admin or Owner roles can activate users. Activated users will be able to log in and track time again.

{
  "status": 1,
  "message": "User activated successfully"
}

        

This endpoint allows you to deactivate (archive) a user without deleting them. Only users with Admin or Owner roles can deactivate users. Deactivated users cannot log in or track time, but their historical data remains intact. Note that Owner accounts cannot be deactivated.

{
  "status": 1,
  "message": "User deactivated successfully"
}