# List test clocks

> The test_clocks.list operation: GET /api/v1/test_clocks in the REST API and the test_clocks_list tool in the MCP server.

Lists the brand's test clocks (test mode), newest first.

Paginate with `limit` (1–100, default 10) and `starting_after` (the `next_cursor` of the previous page).

## At a glance

- **REST:** `GET /api/v1/test_clocks`
- **MCP tool:** `test_clocks_list`
- **Operation ID:** `test_clocks.list`
- **Scope:** Brand
- **Permission:** `subscriptions:read`
- **Risk tier:** `read`
- **Dry run:** Not supported
- **Idempotency:** Not needed (read only)
- **Modes:** Test mode only
- **Pagination:** `limit` (at most 100) and `starting_after`
- **Authentication:** API key with the `subscriptions:read` scope
- **Since:** M5

## Request

### Query parameters

| Field            | Type               | Required | Description |
| ---------------- | ------------------ | -------- | ----------- |
| `limit`          | integer (1 to 100) | No       |             |
| `starting_after` | `clk_…` ID         | No       |             |

## Response

`200 OK` with a JSON object, a page of the list (newest first):

| Field               | Type                                            | Description                                                                                                                                                |
| ------------------- | ----------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `object`            | `"list"`                                        |                                                                                                                                                            |
| `data`              | array of object                                 |                                                                                                                                                            |
| `data[].id`         | `clk_…` ID                                      |                                                                                                                                                            |
| `data[].object`     | `"test_clock"`                                  |                                                                                                                                                            |
| `data[].livemode`   | `false`                                         |                                                                                                                                                            |
| `data[].brandId`    | `brd_…` ID                                      |                                                                                                                                                            |
| `data[].name`       | string                                          |                                                                                                                                                            |
| `data[].frozenTime` | date-time                                       | The clock's time: its customers' subscriptions bill as if it were now.                                                                                     |
| `data[].status`     | one of `ready`, `advancing`, `internal_failure` | `ready`, `advancing` (an advance runs: wait for `ready`) or `internal_failure` (the last advance stopped on an error, see `advance.error`; advance again). |
| `data[].advance`    | object or null                                  | The latest advance.                                                                                                                                        |
| `data[].version`    | integer                                         |                                                                                                                                                            |
| `data[].createdAt`  | date-time                                       |                                                                                                                                                            |
| `data[].updatedAt`  | date-time                                       |                                                                                                                                                            |
| `has_more`          | boolean                                         |                                                                                                                                                            |
| `next_cursor`       | `clk_…` ID or null                              |                                                                                                                                                            |

## Examples

### The brand's clocks

```http
GET /api/v1/test_clocks
Authorization: Bearer or_test_…
```

Response (`200`):

```json
{
  "object": "list",
  "data": [
    {
      "id": "clk_01jacq4m3xf0v8w9zq2y7k5n6h",
      "object": "test_clock",
      "livemode": false,
      "brandId": "brd_01jacq4m3xf0v8w9zq2y7k5n6b",
      "name": "Monthly renewal",
      "frozenTime": "2026-10-20T09:00:00.000Z",
      "status": "ready",
      "advance": null,
      "version": 1,
      "createdAt": "2026-10-20T09:00:00.000Z",
      "updatedAt": "2026-10-20T09:00:00.000Z"
    }
  ],
  "has_more": false,
  "next_cursor": null
}
```

## Errors

| Code                                                                                     | HTTP status | When                                                              | What to do                                                                                                                           |
| ---------------------------------------------------------------------------------------- | ----------- | ----------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ |
| [`validation_failed`](https://ownrecord.io/docs/reference/errors.md#validation_failed)   | 400         | A pagination value is malformed.                                  | Fix the fields listed in `details.issues` and send the request again.                                                                |
| [`mode_not_supported`](https://ownrecord.io/docs/reference/errors.md#mode_not_supported) | 400         | The request is in live mode: test clocks exist in test mode only. | Use the mode the operation supports (`details.supported_mode`): test-only operations such as test clocks need test-mode credentials. |
| [`permission_denied`](https://ownrecord.io/docs/reference/errors.md#permission_denied)   | 403         | The credentials can't read this brand's subscriptions.            | Ask an organization owner or admin for a role or scope that allows this action.                                                      |

It can also return these [common errors](https://ownrecord.io/docs/reference.md#common-errors): [`api_version_unsupported`](https://ownrecord.io/docs/reference/errors.md#api_version_unsupported), [`authentication_required`](https://ownrecord.io/docs/reference/errors.md#authentication_required), [`api_key_invalid`](https://ownrecord.io/docs/reference/errors.md#api_key_invalid), [`scope_required`](https://ownrecord.io/docs/reference/errors.md#scope_required), [`resource_not_found`](https://ownrecord.io/docs/reference/errors.md#resource_not_found), [`dry_run_not_supported`](https://ownrecord.io/docs/reference/errors.md#dry_run_not_supported), [`rate_limited`](https://ownrecord.io/docs/reference/errors.md#rate_limited), [`internal_error`](https://ownrecord.io/docs/reference/errors.md#internal_error).