---
title: "List test plans"
method: GET
path: "/api/plans"
tags: ["Test Plans"]
---

# List test plans

`GET /api/plans`

## Request

- Base URL: `https://aximo.autify.com`
- URL: `https://aximo.autify.com/api/plans`
- Auth: API key in header `x-api-key`
- TypeScript: <https://skmtc.dev/autify/apis/aximo-api/docs/api/plans/get.ts> (a function with typed inputs; its response is checked against the schema)

Lists a workspace's test plans, most recently updated first, with case
counts. Use `GET /api/plans/{planId}` for a plan's full detail
including its ordered cases. `apiEnabled` indicates whether the plan
can be triggered through `POST /api/triggers/plans/{planId}/run`.

## Query parameters

- `projectId` string, uuid, required
- `search` string
- `page` integer
- `pageSize` integer
- `sort` 'title' | 'createdAt' | 'updatedAt'
- `order` 'asc' | 'desc'
- `locale` 'en' | 'ja' | 'ko' | 'und'

## Response `200`

Plans for the workspace, most recently updated first.

- object
  - `items` PlanListItem[], required
    - `id` string, uuid, required
    - `projectId` string, uuid, required
    - `title` string, required
    - `description` string, nullable
    - `apiEnabled` boolean, required: Whether the plan can be triggered through the API.
    - `caseCount` integer, required
    - `hasMobileCases` boolean, required
    - `createdAt` string, date-time, required
    - `updatedAt` string, date-time, required
    - `createdBy` object, nullable
      - `id` string
      - `name` string, nullable
      - `email` string
  - `totalCount` integer, required
  - `page` integer, required
  - `pageSize` integer, required
  - `totalPages` integer, required

## Other responses

- `400`: Invalid query parameters.
- `401`: Missing or invalid API key.
- `404`: Project not found.
- `429`: Rate limit exceeded — e.g. the daily session limit was reached for the organization, or too many API requests were sent in a short window (retry after the number of seconds in the `Retry-After` header).
- `500`: Unexpected server error.

---

[API](https://skmtc.dev/autify/apis/aximo-api.md) - [All operations](https://skmtc.dev/autify/apis/aximo-api/llms.txt) - [OpenAPI document](https://skmtc.dev/autify/apis/aximo-api/revisions/590722011284?raw)