List all workspace users

Returns a list of all users in the workspace, including employees, organization members, and support users. This endpoint is optimized for common list data retrieval and provides essential user information for dropdowns, user pickers, and other UI components that need to display workspace users. The response includes user identification (ID, name, avatar), position/title, employee ID (if applicable), user type, login capability, and deletion status. Organization members have restricted visibility: they only see users from their own organization, not all workspace users. Use the type query parameter to filter by user type (Employee, OrganizationMember, LeadtimeSupport, Agent). By default, deleted users are included in the response; set includeDeleted=false to exclude them.

GET/workspace/users

Authorization

AuthorizationOAuth2 access token · headerrequired

Scopes:api:read

AuthorizationBearer token (JWT) · headerrequired

Query parameters

typestring

Filter users by user type. Options: Employee (internal workspace employees), OrganizationMember (external organization members), LeadtimeSupport (Leadtime support staff), Agent (automation/service accounts). If not specified, all user types are returned.

Allowed:EmployeeOrganizationMemberLeadtimeSupportHelpdeskUserAgent

includeDeletedboolean

Whether to include deleted users in the response. Default is true (deleted users are included). Set to false to exclude deleted users from the results.

default: true

Responses

200

Workspace users retrieved successfully

Array of WorkspaceUserDto

agentSystemKeyobject | null

System agent provider key for agent users, such as cursorCloud, devin, or claudeManaged. Null for human users and generic self-hosted agents.

avatarIdobject

File ID of the user avatar image. Use this ID with the file API to retrieve the avatar image URL. Null if no avatar has been uploaded for this user.

canLoginbooleanrequired

Indicates whether the user account is active and can log in to the workspace. False if the user account is inactive, suspended, or otherwise unable to authenticate.

employeeIdobject

Employee ID associated with this user, if the user is an Employee type. This links the user to their employee record which contains additional employee-specific information. Null if the user is not an Employee or does not have an associated employee record.

idstringrequired

Unique identifier for the user. Use this ID to reference the user in other API endpoints or when assigning tasks, projects, or other entities to users.

isDeletedbooleanrequired

Indicates whether the user account has been soft-deleted. Deleted users are typically hidden from active user lists but may still be included in responses depending on the includeDeleted query parameter.

namestringrequired

Full display name of the user, constructed from firstName and lastName. This is the name shown in user lists, dropdowns, and throughout the application interface.

positionstringrequired

Job title or position of the user within the workspace or organization. This field may be empty for users who do not have a position set.

userTypestringrequired

Type of user account. Options: Employee (internal workspace employee), OrganizationMember (external organization member), LeadtimeSupport (Leadtime support staff), Agent (workspace automation/service account). The user type determines what features and data the user can access.

Allowed:EmployeeOrganizationMemberLeadtimeSupportHelpdeskUserAgent

401

Unauthorized - Invalid or missing authentication token

403

Forbidden - Insufficient API scopes or permissions

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

OAuth2 access tokenRemember on this deviceInclude my values in samples

Parameters

typequeryFilter users by user type. Options: Employee (internal workspace employees), OrganizationMember (external organization members), LeadtimeSupport (Leadtime support staff), Agent (automation/service accounts). If not specified, all user types are returned.includeDeletedqueryWhether to include deleted users in the response. Default is true (deleted users are included). Set to false to exclude deleted users from the results.

Request

curl -X GET "https://leadtime.app/api/public/workspace/users" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

const response = await fetch("https://leadtime.app/api/public/workspace/users", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_ACCESS_TOKEN"
  }
});

import requests

response = requests.get(
    "https://leadtime.app/api/public/workspace/users",
    headers={
        "Authorization": "Bearer YOUR_ACCESS_TOKEN"
    },
)

Response

[
  {
    "agentSystemKey": {},
    "avatarId": {},
    "canLogin": true,
    "employeeId": {},
    "id": "string",
    "isDeleted": true,
    "name": "string",
    "position": "string",
    "userType": "Employee"
  }
]