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

# List Grants

`GET /grants`

## Request

- Base URL: `https://api.os3robotics.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.os3robotics.com/grants`
- Auth: one of:
  - HTTP bearer
  - HTTP bearer

The caller's grants (a workspace sees its own and tenant-wide ones) and balances.

## Query parameters

- `workspace_id` string, uuid, nullable
- `limit` integer
- `after` integer

## Response `200`

Successful Response

- GrantsPage
  - `grants` Grant[], required
    - `id` integer, required
    - `workspace_id` string, uuid, nullable, required
    - `meter` string, required
    - `quantity` string, required
    - `unit` string, required
    - `kind` string, required
    - `source` string, required
    - `granted_at` string, date-time, required
    - `expires_at` string, date-time, nullable, required
    - `correction_of` integer, nullable, required
  - `balances` object, required
  - `remaining` object, required
  - `overage` object, required

## Other responses

- `422`: Validation Error

---

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