---
title: "List grants for a workspace"
method: GET
path: "/v2/workspaces/{workspaceId}/grants"
tags: ["Workspaces"]
---

# List grants for a workspace

`GET /v2/workspaces/{workspaceId}/grants`

## Request

- Base URL: `https://api.sigmacomputing.com`
- URL: `https://api.sigmacomputing.com/v2/workspaces/{workspaceId}/grants`
- Auth: HTTP bearer

This endpoint retrieves a list of all permission grants associated with a specific workspace, identified by its workspaceId.

### Usage notes
- Retrieve the **workspaceId** by calling the [/v2/workspaces](https://help.sigmacomputing.com/reference/list-workspaces) endpoint.
- Optionally use the `page` and `limit` parameters to manage the size of the returned data and navigate through large sets of data.

### Usage scenarios
- **Access control management**: Useful for administrators to review and manage who has what access to the workspace.
- **Audit and compliance**: Assists in compliance checks and audits by providing a clear view of the permissions granted to different users and teams.

### Best practices
- **Use pagination**: Especially important for workspaces with a large number of grants to ensure performance and usability.
- **Regular review**: Regularly review and update the workspace grants to ensure they align with current organizational policies and user roles.

## Path parameters

- `workspaceId` string, required

## Query parameters

- `page` string
- `limit` number, double

## Response `200`

The response body.

- WorkspacesListWorkspaceGrantsResponse200
  - `entries` V2WorkspacesWorkspaceIdGrantsGetResponsesContentApplicationJsonSchemaEntriesItems[], required
    - `grantId` string, required: The unique identifier of the grant
    - `inodeId` string, required: The unique identifier of the inode
    - `organizationId` string, required: The unique identifier of the organization
    - `memberId` string, nullable, required: The unique identifier of the member
    - `teamId` string, nullable, required: The unique identifier of the team
    - `permission` union, required: The permission granted to the member
      - 'admin' | 'annotate' | 'update' | 'usage' | 'writeback': Valid inode types: table, connection database, and connection schema.
      - 'create' | 'annotate' | 'organize' | 'explore' | 'view' | 'edit' | 'apply': Valid inode types: folder, workspace, workbook, dataset, and data model. Can Contribute permissions are listed as **organize** and Can Manage permissions are listed as **edit**.
      - 'view' | 'edit' | 'apply': Valid inode types: version tag.
    - `createdBy` string, required: The identifier of the user who created this grant
    - `updatedBy` string, required: The identifier of the user or process that last updated this grant
    - `createdAt` string, date-time, required: When the grant was created
    - `updatedAt` string, date-time, required: When the grant was last updated
  - `nextPage` string, nullable, required
  - `total` number, double
  - `hasMore` boolean: **[Deprecated]** Indicates whether more results are available.

---

[API](https://skmtc.dev/sigmacomputing/apis/sigma-rest-api.md) - [All operations](https://skmtc.dev/sigmacomputing/apis/sigma-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/sigmacomputing/apis/sigma-rest-api/revisions/fb6036208c49?raw)