---
title: "The brand's Free teams by the state of their Free period (active, ending, ended, paused, site_cap, exempt), ending soonest first"
method: GET
path: "/operator/trials"
tags: ["Operator"]
---

# The brand's Free teams by the state of their Free period (active, ending, ended, paused, site_cap, exempt), ending soonest first

`GET /operator/trials`

## Request

- Base URL: `https://hostingsurge.com/api/v1`
- URL: `https://hostingsurge.com/api/v1/operator/trials`
- Auth: one of:
  - HTTP bearer
  - API key in cookie `__Host-hs_session`

## Query parameters

- `filter` 'active' | 'ending' | 'ended' | 'paused' | 'site_cap' | 'exempt'
- `limit` integer
- `offset` integer, nullable

## Response `200`

Free teams

- object
  - `items` object[], required
    - `state` 'none' | 'active' | 'site_cap' | 'ended' | 'paused' | 'exempt', required
    - `startedAt` string, nullable, required: ISO-8601 timestamp
    - `endsAt` string, nullable, required: ISO-8601 timestamp
    - `endedAt` string, nullable, required: ISO-8601 timestamp
    - `endReason` 'time' | 'sites' | 'usage' | 'operator' | 'null', nullable, required
    - `sitesDeployed` integer, required
    - `sitesMax` integer, nullable, required
    - `pauseAt` string, nullable, required: ISO-8601 timestamp
    - `retentionUntil` string, nullable, required: ISO-8601 timestamp
    - `paymentsAvailable` boolean, required
    - `mode` 'off' | 'dry_run' | 'on'
    - `showCountdown` boolean
    - `usageCapped` object, nullable
      - `metric` 'requests' | 'bandwidthGb' | 'cpuHours', required
      - `at` string, required: ISO-8601 timestamp
    - `organizationId` string, uuid, required
    - `organizationName` string, required
    - `stored` boolean, required: false: computed only (the dry run, or not started yet)
  - `total` integer, required
  - `limit` integer, required
  - `offset` integer, required

## Other responses

- `400`: Invalid request (code invalid_request)
- `403`: An action on an operator-console session older than 5 minutes (code forbidden, details.reauthenticate: sign in again at /admin/login), or an operator removed since the session was resolved
- `404`: Not found (code not_found); also the answer to any request without a live operator-console session (no admin cookie, a dashboard session, an API/MCP key or OAuth token, or a caller who is not a platform operator)
- `429`: Too many requests (code rate_limited); see Retry-After
- `501`: Not available on this server (code not_configured)

---

[API](https://skmtc.dev/hostingsurge/apis/hostingsurge-platform-api.md) · [All operations](https://skmtc.dev/hostingsurge/apis/hostingsurge-platform-api/llms.txt) · [OpenAPI document](https://skmtc.dev/hostingsurge/apis/hostingsurge-platform-api/revisions/4d08337cdff1?raw)
