---
title: "List workspaces"
method: GET
path: "/workspaces"
tags: ["Workspaces"]
---

# List workspaces

`GET /workspaces`

## Request

- Base URL: `https://www.happyscribe.com/api/v1`
- URL: `https://www.happyscribe.com/api/v1/workspaces`
- Auth: API key in header `Authorization`

Returns the workspaces the authenticated user belongs to, oldest first,
paginated at 100 per page.

## Query parameters

- `page` integer
- `per_page` integer

## Response `200`

A paginated list of the user's workspaces.

- object
  - `workspaces` Workspace[]: The workspaces the API key belongs to.
    - `id` string: Workspace ID, beginning with `wks_`. Treat it as an opaque string.
    - `name` string: The workspace name, shown to its members in HappyScribe.
    - `role` 'owner' | 'admin' | 'member' | 'guest': The authenticated user's role in this workspace. - `owner`: owns the workspace. - `admin`: manages the workspace. - `member`: records and reads their own meetings. - `guest`: sees only what is shared with them.
    - `created_at` string, date-time: When it was created, in ISO 8601.
    - `updated_at` string, date-time: When it last changed, in ISO 8601.
    - `owner_email` string: (staff only) Email address of the workspace owner.
    - `members_count` integer: (staff only) Number of members, excluding guests and deleted users.
    - `is_human_transcription_allowed` boolean: (staff only) Whether the workspace may order human transcription.
    - `is_human_translation_allowed` boolean: (staff only) Whether the workspace may order human translation.
    - `email_domains` string[]: (staff only) Domains that auto-join the workspace at sign-up.
    - `idp_company_names` string[]: (staff only) IdP company names configured for SSO.
    - `currency` string: (staff only) Billing currency code, e.g. `usd`, `eur`, `gbp`.
    - `metadata` Metadata: Your own key-value pairs, for your ids and context. HappyScribe stores them, returns them on the object and in every webhook that carries it, and never acts on them. Up to 50 keys of up to 40 characters (no square brackets), values up to 500 characters. See [metadata](/meetingkit/setup#a-workspace-per-customer).
  - `_links` PaginationLinks: Pagination links. `next` is omitted on the last page.
    - `next` object: The next page, with the same filters. Absent on the last page.
      - `url` string: URL of the next page.

## Other responses

- `401`: Your API key is missing (`missing_api_key`) or wrong (`invalid_api_key`), or it may not access this resource (`unauthorized`).

---

[API](https://skmtc.dev/happyscribe/apis/happyscribe-api.md) - [All operations](https://skmtc.dev/happyscribe/apis/happyscribe-api/llms.txt) - [OpenAPI document](https://skmtc.dev/happyscribe/apis/happyscribe-api/revisions/1281bd968c3d?raw)