---
title: "Get Workspaces Users"
method: GET
path: "/api/v1/workspaces/users"
tags: ["Workspace"]
---

# Get Workspaces Users

`GET /api/v1/workspaces/users`

Returns all workspace_users for a given workspace if workspace_id is
provided. Otherwise, returns all workspace_users for all workspaces that
the requesting user is part of.

_Not accessible by guests._

## Query parameters

- `workspace_id` integer, nullable — ID of the workspace to list users for.
- `cursor` string, nullable — An opaque string used as the cursor for pagination. Must be used with the same parameters from the previous request
- `limit` integer — Maximum number of workspace users to return.
- `sort` 'id' | 'name' — Order workspace users by ID, or by name with the requesting user first. Name sorting requires workspace_id.

## Response `200`

Successful Response

- UsersResponse
  - `has_more` boolean, required — Whether more results are available.
  - `next_cursor` string — Cursor for the next page of results.
  - `workspace_users` MemberView[], required — Workspace users in the current page.
    - `user_id` string, required — String ID of the workspace member.
    - `workspace_id` string, required — String ID of the workspace.
    - `user_email` string, required — Email address of the workspace member.
    - `full_name` string, required — Full name of the workspace member.
    - `timezone` string, required — Timezone of the workspace member.
    - `role` 'ADMIN' | 'MEMBER' | 'GUEST', required — Role of the user inside the workspace
    - `image_id` string, nullable — Avatar image ID of the workspace member, or `null`.
    - `is_deleted` boolean — Whether the workspace member is deleted.

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `403` — Forbidden
- `404` — Not Found

---

[API](https://skmtc.net/todoist/apis/todoist-api.md) · [All operations](https://skmtc.net/todoist/apis/todoist-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/todoist/todoist-api/revisions/69a962f1578f/schema)