55e225ee4219

latestOpenAPI 3.1.02026-08-04150110.3 KB

Scenario

Fetch headcount and employees within the scenario

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

get/{domain}/v1/scenarios/{id}/export

Path parameters

idstring required

domainstring required

Response

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

employee-typestring nullable

Type of employment

departmentstring nullable

Department name

equitynumber double nullable

Equity compensation

target-variablenumber 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-equitynumber double nullable

Target equity

target-basenumber double nullable

Target base pay

opening-idstring nullable

ATS opening ID

sub-team-fieldstring nullable

Sub-team field

reporting-managerstring nullable

Name of reporting manager

target-bonus-percnumber double nullable

Target bonus percentage

headcount-typestring nullable

Type of headcount

budget-typestring nullable

Type of budget

basenumber double nullable

Base pay amount

sub-team-archivedboolean nullable

Whether sub-team is archived

job-idstring nullable

Job ID from ATS

pay-currencystring nullable

Currency for pay

target-start-datestring nullable

Target start date

scenario-idstring nullable

Scenario display ID

divisionstring nullable

Division name

hris-employee-idstring nullable

HRIS Employee ID

remaining-budgetnumber double nullable

Remaining budget

job-levelstring nullable

Job level

locationstring nullable

Work location

statusstring nullable

Current status

variablenumber double nullable

Variable compensation

pay-ratestring nullable

Pay rate frequency

target-bonusnumber double nullable

Target bonus amount

job-titlestring nullable

Job title or role

backfill-employeestring nullable

Backfill employee name

sub-team-employeestring nullable

Sub-team employee name

budget-impactnumber double nullable

Budget impact amount

employee-namestring nullable

Employee name

job-rolestring nullable

Job role

target-impactnumber double nullable

Target impact or target budget

equity-currencystring nullable

Currency for equity

contract-end-datestring nullable

Contract end date if applicable

teamstring nullable

Team name

initiativestring nullable

Initiative name

scenario-namestring nullable

Name of the scenario

employment-end-datestring date-time nullable

Employment end date

teamohana-idstring nullable

TeamOhana Employee ID

justificationstring nullable

Justification for headcount

Example response

[
  {
    "headcount-id": "GH-292",
    "scenario-name": "Updating budget comp",
    "pay-rate": "YEAR",
    "department": "Account Management",
    "entity-type": "headcount",
    "variable": null,
    "equity": null,
    "contract-end-date": null,
    "remaining-budget": -231240,
    "job-id": "",
    "division": "Sales",
    "job-role": "Mid-Market Account Manager II",
    "target-start-date": "2025-07-01T00:00:00Z",
    "initiative": "Backfill (2025 Promo/Transfer)",
    "employee-type": "Full time",
    "job-title": "Mid-Market Account Manager II",
    "target-base": 103400,
    "scenario-id": "SC-7",
    "teamohana-id": null,
    "target-impact": 231240,
    "justification": "Deleted code is debugged code. -Jeff Sickel",
    "team": "Sales",
    "priority": "High",
    "pay-currency": "USD",
    "status": "Hired",
    "budget-impact": 0,
    "employee-name": null,
    "headcount-type": "Backfill",
    "opening-id": "",
    "target-variable": 84600,
    "job-level": "P3",
    "equity-currency": null,
    "target-equity": 0,
    "base": null,
    "budget-type": "Budgeted",
    "backfill-employee": "Fred Lakin",
    "location": "United States of America",
    "reporting-manager": "Alex Rogahn",
    "hris-employee-id": null
  },
  {
    "headcount-id": "",
    "scenario-name": "Updating budget comp",
    "pay-rate": "YEAR",
    "department": "Platform",
    "entity-type": "employee",
    "variable": 10667,
    "equity": null,
    "contract-end-date": null,
    "remaining-budget": null,
    "job-id": "",
    "division": "Engineering",
    "job-role": null,
    "target-start-date": "2021-11-16T00:00:00Z",
    "initiative": null,
    "employee-type": "Regular",
    "job-title": "Senior Data Engineer II",
    "target-base": null,
    "scenario-id": "SC-7",
    "teamohana-id": "TO-1410",
    "target-impact": null,
    "justification": null,
    "team": null,
    "priority": null,
    "pay-currency": "USD",
    "status": null,
    "budget-impact": null,
    "employee-name": "Lecia Wolf",
    "headcount-type": null,
    "opening-id": "",
    "target-variable": null,
    "job-level": "P4",
    "equity-currency": null,
    "target-equity": null,
    "base": 191492.45,
    "budget-type": null,
    "backfill-employee": null,
    "location": "Distributed - TX",
    "reporting-manager": "Zoraida Gleichner",
    "hris-employee-id": "983"
  }
]