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

# List workspace roles

`GET /workspaces/{workspaceId}/roles`

Returns a list of the counts of users over time by role for the workspace.

## Path parameters

- `workspaceId` string, required

## Response `200`

List of role activity over time for the workspace.

- GetWorkspaceRoleActivity — Response for getting workspace role activity.
  - `items` WorkspaceRoleActivity[], required
    - `month` string, required — Month corresponding to the data.
    - `activeAdminCount` number, required — Number of active Admins.
    - `activeDocMakerCount` number, required — Number of active Doc Makers.
    - `activeEditorCount` number, required — Number of active Editors.
    - `inactiveAdminCount` number, required — Number of inactive Admins.
    - `inactiveDocMakerCount` number, required — Number of inactive Doc Makers.
    - `inactiveEditorCount` number, required — Number of inactive Editor users.

## 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)