---
title: "List hiring plans"
method: GET
path: "/{domain}/v1/plans"
tags: ["Discovery"]
---

# List hiring plans

`GET /{domain}/v1/plans`

## Request

- Base URL: `https://api.teamohana.us` (the document declares no server; this is the origin it was published from)
- URL: `https://api.teamohana.us/{domain}/v1/plans`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/teamohana/apis/teamohana-public-api/docs/:domain/v1/plans/get.ts> (a function with typed inputs; its response is checked against the schema)

Returns all hiring plans for the org. Use the returned id to filter GET /v1/headcount by plan.

## Path parameters

- `domain` string, required

## Response `200`

List of hiring plans.

- object[]: List of hiring plans for the org.
  - `id` string, uuid, required: UUID
  - `name` string, required: Display name
  - `is-active` boolean, required: Whether this is the currently active plan
  - `start-date` string, date-time, nullable: Plan start date
  - `end-date` string, date-time, nullable: Plan end date

## Other responses

- `401`: Request does not contain valid credentials.

---

[API](https://skmtc.dev/teamohana/apis/teamohana-public-api.md) - [All operations](https://skmtc.dev/teamohana/apis/teamohana-public-api/llms.txt) - [OpenAPI document](https://skmtc.dev/teamohana/apis/teamohana-public-api/revisions/87f9835cbb94?raw)
