---
title: "Fetch headcount and employees within the scenario"
method: GET
path: "/{domain}/v1/scenarios/{id}/export"
tags: ["Scenario"]
---

# Fetch headcount and employees within the scenario

`GET /{domain}/v1/scenarios/{id}/export`

## 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/scenarios/{id}/export`
- Auth: HTTP bearer

Get a list of all headcount and employees within the scenario.

## Path parameters

- `id` string, required
- `domain` string, required

## Response `200`

A list response containing all headcount and employees within the scenario.

- object[]: List of export records
  - `employee-type` string, nullable: Type of employment
  - `department` string, nullable: Department name
  - `equity` number, double, nullable: Equity compensation
  - `target-variable` number, double, nullable: Target variable pay
  - `priority` 'High' | 'Normal' | 'Critical' | 'Low', nullable: Priority of the Headcount.
  - `entity-type` 'headcount' | 'employee', nullable: Type of entity (headcount or employee)
  - `target-equity` number, double, nullable: Target equity
  - `target-base` number, double, nullable: Target base pay
  - `opening-id` string, nullable: ATS opening ID
  - `sub-team-field` string, nullable: Sub-team field
  - `reporting-manager` string, nullable: Name of reporting manager
  - `target-bonus-perc` number, double, nullable: Target bonus percentage
  - `headcount-type` string, nullable: Type of headcount
  - `budget-type` string, nullable: Type of budget
  - `base` number, double, nullable: Base pay amount
  - `sub-team-archived` boolean, nullable: Whether sub-team is archived
  - `job-id` string, nullable: Job ID from ATS
  - `pay-currency` string, nullable: Currency for pay
  - `target-start-date` string, nullable: Target start date
  - `scenario-id` string, nullable: Scenario display ID
  - `division` string, nullable: Division name
  - `hris-employee-id` string, nullable: HRIS Employee ID
  - `remaining-budget` number, double, nullable: Remaining budget
  - `job-level` string, nullable: Job level
  - `location` string, nullable: Work location
  - `status` string, nullable: Current status
  - `variable` number, double, nullable: Variable compensation
  - `pay-rate` string, nullable: Pay rate frequency
  - `target-bonus` number, double, nullable: Target bonus amount
  - `job-title` string, nullable: Job title or role
  - `backfill-employee` string, nullable: Backfill employee name
  - `sub-team-employee` string, nullable: Sub-team employee name
  - `budget-impact` number, double, nullable: Budget impact amount
  - `employee-name` string, nullable: Employee name
  - `job-role` string, nullable: Job role
  - `target-impact` number, double, nullable: Target impact or target budget
  - `equity-currency` string, nullable: Currency for equity
  - `contract-end-date` string, nullable: Contract end date if applicable
  - `team` string, nullable: Team name
  - `initiative` string, nullable: Initiative name
  - `scenario-name` string, nullable: Name of the scenario
  - `employment-end-date` string, date-time, nullable: Employment end date
  - `teamohana-id` string, nullable: TeamOhana Employee ID
  - `justification` string, nullable: Justification for headcount

## Other responses

- `404`: No such resource found or access denied. Please check the id.
- `500`: Something went wrong at TeamOhana. Please contact support.

---

[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)