--- title: "Fetch all the headcount in TeamOhana." method: GET path: "/{domain}/v1/headcount" tags: ["Headcount"] --- # Fetch all the headcount in TeamOhana. `GET /{domain}/v1/headcount` ## 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/headcount` - Auth: HTTP bearer - TypeScript: (a function with typed inputs; its response is checked against the schema) Get a list of all valid headcount that exists in TeamOhana. Supports optional filtering by plan, status, hiring status, department, and division. Response format is selected via the Accept header (`application/json` default, `text/csv` for a downloadable CSV). Refer to the [Headcount Data API FAQ](/faq/index.html#headcount-data-api) for more details. ## Path parameters - `domain` string, required ## Query parameters - `plan-id` string, uuid, nullable: Filter by hiring plan UUID. Get IDs from GET /v1/plans. - `hc-status` union: Filter by headcount status code. Repeatable for OR. Valid values: in-approval, approved, denied, closed, archived. - unknown - unknown[] - unknown - `hc-hiring-status` union: Filter by hiring status code. Repeatable for OR. Valid values: not-started, ready-to-hire, in-progress, offer-sent, hired. - unknown - unknown[] - unknown - `department-id` string, uuid, nullable: Filter by department. Pass the id returned by GET /v1/departments (a division-department UUID that uniquely identifies a department within a division). - `division-id` string, uuid, nullable: Filter by division UUID. Get IDs from GET /v1/divisions. When combined with department-id, returns the union. ## Response `200` A list of headcounts as either a JSON array or a CSV file. - object[] - `termination-date` string, nullable: Termination date of the employee if exists. - `hiring-status` 'Offer Sent' | 'Hired' | 'Ready to hire' | 'Not started' | 'In progress', nullable: Current status of the headcount. - `employee-type` string, nullable, required: Type of the employee. - `department` string, nullable, required: Department of the Headcount. - `headcount-approved-date` string, nullable: Approved date of the Headcount. - `target-variable` number, double, nullable: Target variable of the Headcount. - `target-equity-currency` string, nullable: Equity currency of the Headcount. - `priority` 'High' | 'Normal' | 'Critical' | 'Low', nullable: Priority of the Headcount. - `target-equity` number, double, nullable: Target equity of the Headcount. - `custom-fields` object: All custom fields associated with this Headcount. - `opening-id` string, nullable: Opening ID of the Headcount. - `budget-equity` number, double, nullable: Budget equity of the Headcount. - `headcount-id` string, nullable: Headcount ID exists in TeamOhana. - `sourcers` string, nullable: Names of the sourcers split by `;` - `actual-bonus` number, double, nullable: Actual bonus of the Headcount. - `budget-salary` number, double, nullable: Budget salary of the Headcount. - `reporting-manager` string, nullable, required: Name of the reporting manager. - `termination-type` string, nullable: Termination type of the employee if exists. - `recruiters` string, nullable: Names of the recruiters split by `;` - `annualized-budget-salary` number, double, nullable: Budget salary calculated annually. - `target-bonus-perc` number, double, nullable: Target bonus-perc of the Headcount. - `actual-equity` number, double, nullable: Actual equity of the Headcount. - `actual-variable` number, double, nullable: Actual variable of the Headcount. - `compensation-change-reason` string, nullable: Docker specific field - `budget-job-level` string, nullable: Budget job level of the Headcount. - `headcount-type` 'Backfill' | 'New hire', nullable: Type of the Headcount - either New hire or Backfill. - `id` string, uuid, nullable: Headcount UUID. Present when the response contains only Headcount and no Employee data. - `archived-justification` string, nullable: Justification of archival if the Headcount is archived. - `archived-date` string, nullable: Archival date of the Headcount if this is archived. - `headcount-display-id` string, nullable: Headcount ID - `backfill-employee-email` string, nullable: Email of the backfill employee if this Headcount is a backfill. - `headcount-denied-date` string, nullable: Denied date of the Headcount if this is denied. - `headcount-is-private` boolean, nullable: Whether the Headcount is private. - `actual-bonus-perc` number, double, nullable: Actual bonus-perc of the Headcount. - `target-start-date` string, nullable, required: Target start date of the Headcount. - `budget-start-date` string, nullable: Budget start date of the Headcount. - `is-current` boolean, nullable: Whether the Headcount is included in current hiring plan or not. - `division` string, nullable, required: Division of the Headcount. - `employee-email` string, nullable: Employee email - `budget-pay-rate` string, nullable: Budget pay rate of the Headcount. - `hris-employee-id` string, nullable: HRIS Employee ID - `job-level` string, nullable, required: Job level of the Headcount. - `job-name` string, nullable: Job name of the Headcount - concatenation of ATS job-id and job name. - `denied-justification` string, nullable: Justification of denial if the Headcount is denied. - `hiring-plan-active` boolean, nullable: Whether the Headcount is included in current hiring plan or not. - `actual-salary` number, double, nullable: Actual salary of the Headcount. - `location` string, nullable, required: Location of the Headcount. - `employee-id` string, uuid, nullable: TeamOhana UUID of the employee hired into the headcount. Present on headcount rows only. - `reporting-manager-email` string, nullable: Email of the reporting manager. - `last-updated` string, date-time, nullable: Last update date of the Headcount. - `headcount-status` 'Filled' | 'Approved' | 'Denied' | 'In Approval' | 'Archived', nullable: Current status of the Headcount. - `actual-equity-currency` string, nullable: Actual Equity currency of the Headcount. - `status` 'Filled' | 'Approved' | 'Denied' | 'In Approval' | 'Archived', nullable: Current status of the Headcount. - `actual-start-date` string, nullable: Actual start date of the Headcount. - `target-open-date` string, nullable: Target open date of the Headcount. - `pay-rate` string, nullable: Pay rate of the Headcount. - `target-bonus` number, double, nullable: Target bonus of the Headcount. - `budget-currency` string, nullable: Budget currency of the Headcount. - `job-title` string, nullable, required: Job title of the Headcount. - `future-termination` boolean, nullable: Is the employee termination in future - `backfill-employee` string, nullable: Name of the backfill employee for this Headcount. - `annualized-actual-salary` number, double, nullable: Actual salary calculated annually. - `backfill-employee-id` string, nullable: Employee ID of backfilled employee for the Headcount. - `track-management` string, nullable: Docker specific field - `hris-employee-remote-id` string, nullable: HRIS Remote Employee ID - `target-salary` number, double, nullable: Target salary of the Headcount. - `target-currency` string, nullable: Target currency of the Headcount. - `hiring-plan` string, nullable: Name of the hiring plan - `state` string, nullable: Docker specific field - `annualized-target-salary` number, double, nullable: Target salary calculated annually for this Headcount. - `employee-name` string, nullable, required: Name of the employee. - `offer-sent-date` string, nullable: Offer sent date for the headcount if exists. - `actual-currency` string, nullable: Actual currency of the Headcount. - `budget-variable` number, double, nullable: Budget variable of the Headcount. - `pay-rate-multiplier` number, double, nullable: Pay rate multiplier of the Headcount. - `termination-reconciled` boolean, nullable: Was the employee termination reconciled - `job-role` string, nullable: Job role of the Headcount. - `headcount-url` string, nullable: URL of the Headcount details in TeamOhana. - `reporting-manager-hris-employee-id` string, nullable: HRIS Employee ID of the Reporting manager of the employee - `offer-accept-date` string, nullable: Offer acceptance date for the headcount if exists. - `team` string, nullable: Headcount's team name. - `approval-requested-date` string, nullable: Date of approval for this Headcount . - `initiative` string, nullable: Initiative name of the Headcount if exists. - `job-function` string, nullable: Docker specific field - `target-hire-date` string, nullable: Target hire date of the Headcount. - `target-pay-rate` string, nullable: Target pay rate of the Headcount. - `employment-end-date` string, nullable: Employment end date for the headcount if exists. - `teamohana-id` string, nullable: Teamohana ID - `coordinators` string, nullable: Names of the coordinators split by `;` - `justification` string, nullable: Headcount Justification - `termination-regrettable` boolean, nullable: Was the employee termination regrettable ## Other responses - `401`: Request does not contain valid credentials. - `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)