---
title: "List workspace users"
method: GET
path: "/workspaces/{workspaceId}/users"
tags: ["Workspaces"]
---

# List workspace users

`GET /workspaces/{workspaceId}/users`

Returns a list of members in the given workspace. This list will be ordered with the requesting user first and then ordered by role.

## Path parameters

- `workspaceId` string, required

## Query parameters

- `includedRoles` WorkspaceUserRole[]
- `pageToken` string

## Response `200`

List of workspace members matching the query.

- WorkspaceMembersList — Response for listing workspace users.
  - `items` WorkspaceUser[], required
    - `email` string, required — Email of the user.
    - `name` string, required — Name of the user.
    - `role` 'Admin' | 'DocMaker' | 'Editor', required
    - `pictureUrl` string, url — Picture url of the user.
    - `registeredAt` string, date-time, required — Timestamp for when the user registered in this workspace
    - `roleChangedAt` string, date-time — Timestamp for when the user's role last changed in this workspace.
    - `lastActiveAt` string, date — Date when the user last took an action in any workspace.
    - `ownedDocs` number — Number of docs the user owns in this workspace.
    - `docsLastActiveAt` string, date — Date when anyone last accessed a doc that the user owns in this workspace.
    - `docCollaboratorCount` number — Number of collaborators that have interacted with docs owned by the user in the last 90 days.
    - `totalDocs` number — Number of docs the user owns, manages, or to which they have added pages in the last 90 days.
    - `totalDocsLastActiveAt` string, date — Date when anyone last accessed a doc the member owns or contributed to.
    - `totalDocCollaboratorsLast90Days` number — Number of unique users that have viewed any doc the user owns, manages, or has added pages to in the last 90 days.
  - `nextPageToken` string — If specified, an opaque token used to fetch the next page of results.
  - `nextPageLink` string, url — If specified, a link that can be used to fetch the next page of results.

## Other responses

- `401` — The API token is invalid or has expired.
- `403` — The API token does not grant access to this resource.
- `404` — The resource could not be located with the current API token.
- `429` — The client has sent too many requests.

---

[API](https://skmtc.net/coda/apis/superhuman-docs-api.md) · [All operations](https://skmtc.net/coda/apis/superhuman-docs-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/coda/superhuman-docs-api/versions/c65a8418f3c8/schema)