---
title: "Get a pass window"
method: GET
path: "/v1/projects/{project}/pass-windows/{window}"
tags: ["Pass Windows"]
---

# Get a pass window

`GET /v1/projects/{project}/pass-windows/{window}`

## Request

- Base URL: `https://api.subscriby.net`
- URL: `https://api.subscriby.net/v1/projects/{project}/pass-windows/{window}`
- Auth: HTTP bearer

One window, with `sellable` and `holders` resolved for it. A window is resolved **within the project**: a window id that belongs to another project, another team, or to nothing at all is a `404 RESOURCE_NOT_FOUND`, so an id's existence never leaks.

| Field              | Type    | Notes                                                                                                                                          |
| ------------------ | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
| `starts_at`        | string  | ISO 8601, **UTC**. Store this.                                                                                                                 |
| `ends_at`          | string  | ISO 8601, UTC.                                                                                                                                 |
| `timezone`         | string  | The IANA zone the plan's schedule was authored in. Render window times in this, never in UTC.                                                  |
| `local_range`      | string  | The same window as a person reads it, already in `timezone`: what the dashboard, the portal and the bot all print.                             |
| `duration_minutes` | integer | Derived from the two instants.                                                                                                                 |
| `status`           | string  | `scheduled`, `open`, `closed` or `canceled`. Set by the scheduler as the window's start and end pass; `canceled` only by an explicit cancel.   |
| `source`           | string  | `generated` from the plan's slots, or `manual` when placed by hand. Manual windows survive a schedule rebuild; generated ones are regenerated. |
| `sellable`         | boolean | Whether a buyer could purchase this window right now: the plan's sales cutoff, resolved for the whole page in one query rather than per row.   |
| `holders`          | integer | How many purchases currently hold the window.                                                                                                  |

> **Why both UTC and a local range.** A pass schedule is authored in the creator's zone and rendered in it everywhere else in the product. Returning only UTC would leave every consumer converting, and getting it wrong across a daylight-saving boundary. `starts_at` is for storing and comparing; `local_range` is for showing.

## Path parameters

- `project` string, uuid, required
- `window` string, uuid, required

## Response `200`

The window.

- object
  - `data` PassWindowResource, required: A pass window: one dated stretch of access on a time-limited pass plan, generated from the plan's slots or placed by hand.
    - `id` string, required: The window's id, what a pass series points at.
    - `plan_id` string, required: The pass plan the window belongs to.
    - `plan_name` string, required: That plan's name, so a list reads without a plan lookup.
    - `starts_at` string, required: When access opens, ISO 8601 in UTC. Store and compare this.
    - `ends_at` string, required: When access closes, ISO 8601 in UTC.
    - `timezone` string, nullable, required: The IANA zone the plan's schedule was authored in. Render window times in this, never in UTC.
    - `local_range` string, required: The same window as a person reads it, already in `timezone`; what the dashboard, the portal and the bot all print.
    - `duration_minutes` integer, required: The length in minutes, derived from the two instants.
    - `status` string, required: `scheduled`, `open`, `closed` or `canceled`. Set by the scheduler as the window's start and end pass; `canceled` only by an explicit cancel.
    - `source` string, required: `generated` from the plan's slots, or `manual` when placed by hand. Manual windows survive a schedule rebuild; generated ones are regenerated.
    - `sellable` boolean, required: Whether a buyer could purchase this window right now: the plan's sales cutoff, resolved for the whole page in one query rather than per row.
    - `holders` integer, required: How many purchases currently hold the window.

## Other responses

- `401`: `AUTHENTICATION_REQUIRED`: the request carries no bearer token, or one that is revoked, malformed, or minted for another environment (an `sbt_test_` token on production).
- `403`: `TOKEN_MISSING_ABILITY`: the token is valid but does not carry the ability this endpoint requires; `error.context.required_ability` names the one to grant. An endpoint that also checks who owns a row or which tier the account is on answers `FORBIDDEN`, `TEAM_TIER_REQUIRED` or `CONNECTOR_TIER_REQUIRED` with the same status, and says so in its own description.
- `404`: `RESOURCE_NOT_FOUND`: an id in the path names nothing the token can see. `TENANT_MISMATCH`: the project sits outside the token's `scope:project:` allow-list, or the token carries no team scope. Both answer 404 rather than 403 so that existence outside the token's scope cannot be inferred.
- `429`: `RATE_LIMITED`: the token has spent its 300 requests a minute or 10,000 an hour; `Retry-After` says when the next one is accepted.

---

[API](https://skmtc.dev/memberpass/apis/subscriby-rest-api.md) · [All operations](https://skmtc.dev/memberpass/apis/subscriby-rest-api/llms.txt) · [OpenAPI document](https://skmtc.dev/memberpass/apis/subscriby-rest-api/revisions/59c4df91d764?raw)