---
title: "List grants"
method: GET
path: "/preview/v2/grants"
tags: ["Grants"]
---

# List grants

`GET /preview/v2/grants`

> ⚠️ This endpoint is in [public preview](/preview/roadmap).

List grants, optionally filtered by workspace or principal. Callers without `grant:list` + `grant:read` are restricted to grants whose principal is themselves.

## Query parameters

- `workspace_id` string
- `principal_id` string

## Response `200`

Grants listed.

- SfcApiListGrantsResponse
  - `object` 'list', required
  - `data` SfcApiGrantResponse[], required
    - union
      - object
        - `principal_id` string, required
        - `principal_type` 'user', required
        - `object` 'grant', required
        - `id` string, required
        - `workspace` SfcApiWorkspaceSummary
          - `id` string, required
          - `name` string, required
        - `role` SfcApiRoleSummary, required
          - `id` string, required
          - `name` string, required
        - `created_at` integer, required — Unix timestamp.
      - object
        - `principal_id` string, required
        - `principal_type` 'token', required
        - `object` 'grant', required
        - `id` string, required
        - `workspace` SfcApiWorkspaceSummary
          - `id` string, required
          - `name` string, required
        - `role` SfcApiRoleSummary, required
          - `id` string, required
          - `name` string, required
        - `created_at` integer, required — Unix timestamp.

## Other responses

- `401` — Unauthorized.
- `403` — Forbidden.
- `500` — Internal server error.

---

[API](https://skmtc.net/sfcompute/apis/san-francisco-compute-documentation.md) · [All operations](https://skmtc.net/sfcompute/apis/san-francisco-compute-documentation/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/sfcompute/san-francisco-compute-documentation/revisions/93dd7661e9bb/schema)