---
title: "the instance's standing against the guest allowance"
method: GET
path: "/w/{workspace}/workspaces/guest_usage"
tags: ["workspace"]
---

# the instance's standing against the guest allowance

`GET /w/{workspace}/workspaces/guest_usage`

Instance-wide, since a licence is per instance and one email is one guest however many workspaces it opens. Read by workspace admins and app publishers to see how close the cap (Community and Pro) or the meter (Enterprise) is.

## Path parameters

- `workspace` string, required

## Response `200`

guest usage

- GuestUsage — Guests are free up to `free_allowance` distinct emails over the trailing `window_days`. Past that an Enterprise plan meters them (`metered`, four guests to one seat: `billable_guests`, `guest_seats`); every other plan and build admits no new email until the count drops. `instance_enabled` is the superadmin switch (`guest_access_disabled` global setting) every workspace switch sits under.
  - `instance_enabled` boolean, required
  - `guest_count` integer, required
  - `window_days` integer, required
  - `free_allowance` integer, required
  - `metered` boolean, required
  - `billable_guests` integer, required
  - `guest_seats` integer, required

## Changes

- **2026-09-04** `d25bf4c71250` — 1 info
  - endpoint added

[Change history](https://skmtc.dev/windmill/apis/windmill-api/changes/w/:workspace/workspaces/guest_usage/get.md)

---

[API](https://skmtc.dev/windmill/apis/windmill-api.md) · [All operations](https://skmtc.dev/windmill/apis/windmill-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/windmill/windmill-api/revisions/d25bf4c71250/schema)