get_pass_window

One dated access window of a project's pass plans by UUID — when it runs, whether it is still on sale and how many holders bought it.

Purpose

Read one window back before acting on it. The row is the same shape list_pass_windows returns: the instant it opens and closes, the local range in the plan's own timezone, its lifecycle status, whether it is sellable right now, and how many holders bought it.

`sellable` and `status` answer different questions

status is the lifecycle — scheduled, open, closed, canceled. sellable is whether a customer can buy the window at this moment, after the plan's sales cutoff. A scheduled window can already be closed to sales, and a plan anchored to the window's end keeps selling while it is open. Check sellable before pointing a customer at a window, and holders before cancelling one.

Required ability

pass-window:view

Input schema

{
  "type": "object",
  "required": ["project_id", "window_id"],
  "properties": {
    "project_id": {
      "type": "string",
      "description": "UUID of the project whose pass plans own the window."
    },
    "window_id": {
      "type": "string",
      "description": "UUID of the window to fetch."
    }
  }
}

Output shape

{
  "data": {
    "id": "3d5a8c72-b016-4e94-8fa7-61c209d4e738",
    "plan_id": "9b7c2e15-4d63-4f80-a2b1-7e5d0c9f3a46",
    "plan_name": "Saturday session",
    "starts_at": "2026-10-03T09:00:00+00:00",
    "ends_at": "2026-10-03T11:00:00+00:00",
    "timezone": "Europe/London",
    "local_range": "Sat 3 Oct, 10:00–12:00 BST",
    "duration_minutes": 120,
    "status": "scheduled",
    "sellable": true,
    "holders": 12
  }
}

starts_at and ends_at are UTC instants; local_range is the same span rendered in timezone, which is the plan's pass timezone, so it is what a creator or a member would say out loud.

Example prompts

"Is the 3 October window in project 7f3d1c92-8b45-4e6a-9d21-5c8e0a4b6f13 still on sale, and how many people hold it?"

"Show me window 3d5a8c72-b016-4e94-8fa7-61c209d4e738 before we decide whether to cancel it."

"What local time does that window run?"

Failure modes

  • RESOURCE_NOT_FOUND — unknown project_id or window_id, a window that belongs to another project, or a project outside the token's scope.
  • AUTHENTICATION_REQUIRED — no authenticated user on the request.
  • TOKEN_MISSING_ABILITY — token lacks pass-window:view.

How is this guide?

On this page

Subscriby is a product designed by you — for you.

No boardroom full of executives deciding what we ships next. Our roadmap always shaped by you with your feedback.

Share feedback or a request