---
title: "List case directories"
method: GET
path: "/api/directories"
tags: ["Test Cases"]
---

# List case directories

`GET /api/directories`

## Request

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

List the folders that organize a workspace's test cases. Use a folder's `id`
as `directoryId` on `POST /api/cases` or `GET /api/cases`, and its `path` as
`parentPath` on `POST /api/directories`.

## Query parameters

- `projectId` string, uuid, required

## Response `200`

The workspace's folders.

- DirectoryList
  - `directories` DirectoryListItem[], required: Every folder in the workspace, ordered by path. Not paginated.
    - `id` string, uuid, required
    - `path` string, required: Full folder path from the workspace root, such as `/Regression/Login`.
    - `caseCount` integer, required: Cases directly in this folder. Archived cases are not counted.
  - `unassignedCount` integer, required: Cases not in any folder.
  - `totalCount` integer, required: All non-archived cases in the workspace.

## Other responses

- `400`: Invalid query parameters.
- `401`: Missing or invalid API key.
- `403`: API key is not scoped to an organization, the user is banned, or the user is no longer a member of the organization.
- `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)