---
title: "get_workspace_shares"
method: GET
path: "/v1/workspaces/{workspace_id}/shares"
tags: ["workspaces"]
---

# get_workspace_shares

`GET /v1/workspaces/{workspace_id}/shares`

## Request

- Base URL: `https://ndi-api.nace.ai`
- URL: `https://ndi-api.nace.ai/v1/workspaces/{workspace_id}/shares`
- Auth: API key in header `X-API-Key`
- TypeScript: <https://skmtc.dev/nace/apis/ndi-platform-api/docs/v1/workspaces/:workspace_id/shares/get.ts> (a function with typed inputs; its response is checked against the schema)

Return the workspace owner and every explicitly shared user.

## Path parameters

- `workspace_id` string, uuid, required: Workspace identifier.

## Response `200`

Successful Response

- WorkspaceShares: The owner and explicit users who may access one workspace.
  - `owner_user_id` string, uuid, nullable, required: Console user who owns the workspace, or null for an organization-owned integration workspace.
  - `user_ids` string[], required: Console users with explicit access to the workspace; excludes the owner.
  - `workspace_id` string, uuid, required: Workspace whose sharing configuration this response describes.

## Other responses

- `504`: Gateway Timeout
- `default`: Typed error envelope used by every 4xx and 5xx. ``error.code`` distinguishes the failure; HTTP status is a consequence of the code.

---

[API](https://skmtc.dev/nace/apis/ndi-platform-api.md) - [All operations](https://skmtc.dev/nace/apis/ndi-platform-api/llms.txt) - [OpenAPI document](https://skmtc.dev/nace/apis/ndi-platform-api/revisions/d002a3589a67?raw)