---
title: "Filter workspace users"
method: POST
path: "/v1/workspaces/{workspaceId}/users/info"
tags: ["User"]
---

# Filter workspace users

`POST /v1/workspaces/{workspaceId}/users/info`

## Path parameters

- `workspaceId` string, required — Represents a workspace identifier across the system.

## Request body

- GetUsersRequestV1
  - `accountStatuses` string[] — If provided, you'll get a filtered list of users with the corresponding account status filter. If not, this will only filter ACTIVE, PENDING_EMAIL_VERIFICATION, and NOT_REGISTERED Users.
  - `email` string — If provided, you'll get a filtered list of users that contain the provided string in their email address.
  - `includeRoles` boolean — If you pass along includeRoles=true, you'll get each user's detailed manager role (including projects and members for whom they're managers)
  - `memberships` 'ALL' | 'NONE' | 'WORKSPACE' | 'PROJECT' | 'USERGROUP' — If provided, you'll get all users along with workspaces, groups, or projects they have access to.
  - `name` string — If provided, you'll get a filtered list of users that contain the provided string in their name.
  - `page` integer — Page number.
  - `pageSize` integer — Page size.
  - `projectId` string — If provided, you'll get a list of users that have access to the project.
  - `roles` string[] — If provided, you'll get a filtered list of users that have any of the specified roles. Owners are counted as admins when filtering.
  - `sortColumn` 'ID' | 'EMAIL' | 'NAME' | 'NAME_LOWERCASE' | 'ACCESS' | 'HOURLYRATE' | 'COSTRATE' — Sorting criteria
  - `sortOrder` 'ASCENDING' | 'DESCENDING' — Sorting mode
  - `status` 'PENDING' | 'ACTIVE' | 'DECLINED' | 'INACTIVE' | 'ALL' — If provided, you'll get a filtered list of users with the corresponding status.
  - `userGroups` string[] — If provided, you'll get a list of users that belong to the specified user group IDs.

## Response `200`

OK

- UserDtoV1[] — unresolved $ref

---

[API](https://skmtc.dev/clockify/apis/clockify-api.md) · [All operations](https://skmtc.dev/clockify/apis/clockify-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/clockify/clockify-api/revisions/a5b636acbcd8/schema)