Sign in

v1

latestOpenAPI 3.1.02026-08-04150110.3 KB
Headcount

Fetch all the headcount in TeamOhana.

Get a list of all valid headcount that exists in TeamOhana. Supports optional filtering by plan, status, hiring status, department, and division. Refer to the Headcount Data API FAQ for more details.

post/{domain}/v1/headcount

Path parameters

domainstring required

Query parameters

plan-idstring uuid nullable

Filter by hiring plan UUID. Get IDs from GET /v1/plans.

Filter by hiring plan UUID. Get IDs from GET /v1/plans.

{"stackTrail":"paths:/{domain}/v1/headcount:post:parameters:2:schema:anyOf:0","oasType":"schema","type":"unknown"}
OR

Filter by headcount status code. Repeatable for OR. Valid values: in-approval, approved, denied, closed, archived.

{"stackTrail":"paths:/{domain}/v1/headcount:post:parameters:3:schema:anyOf:0","oasType":"schema","type":"unknown"}
OR

Filter by hiring status code. Repeatable for OR. Valid values: not-started, ready-to-hire, in-progress, offer-sent, hired.

department-idstring 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).

Filter by department. Pass the id returned by GET /v1/departments (a division-department UUID that uniquely identifies a department within a division).

division-idstring uuid nullable

Filter by division UUID. Get IDs from GET /v1/divisions. When combined with department-id, returns the union.

Filter by division UUID. Get IDs from GET /v1/divisions. When combined with department-id, returns the union.

Response

A list response containing all the headcount.

termination-datestring 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-typestring nullable required

Type of the employee.

departmentstring nullable required

Department of the Headcount.

headcount-approved-datestring nullable

Approved date of the Headcount.

target-variablenumber double nullable

Target variable of the Headcount.

target-equity-currencystring nullable

Equity currency of the Headcount.

priority'High' | 'Normal' | 'Critical' | 'Low' nullable

Priority of the Headcount.

target-equitynumber double nullable

Target equity of the Headcount.

custom-fieldsobject

All custom fields associated with this Headcount.

opening-idstring nullable

Opening ID of the Headcount.

budget-equitynumber double nullable

Budget equity of the Headcount.

headcount-idstring nullable

Headcount ID exists in TeamOhana.

sourcersstring nullable

Names of the sourcers split by ;

actual-bonusnumber double nullable

Actual bonus of the Headcount.

budget-salarynumber double nullable

Budget salary of the Headcount.

reporting-managerstring nullable required

Name of the reporting manager.

termination-typestring nullable

Termination type of the employee if exists.

recruitersstring nullable

Names of the recruiters split by ;

annualized-budget-salarynumber double nullable

Budget salary calculated annually.

target-bonus-percnumber double nullable

Target bonus-perc of the Headcount.

actual-equitynumber double nullable

Actual equity of the Headcount.

actual-variablenumber double nullable

Actual variable of the Headcount.

compensation-change-reasonstring nullable

Docker specific field

budget-job-levelstring nullable

Budget job level of the Headcount.

headcount-type'Backfill' | 'New hire' nullable

Type of the Headcount - either New hire or Backfill.

idstring uuid nullable

headcount UUID.

archived-justificationstring nullable

Justification of archival if the Headcount is archived.

archived-datestring nullable

Archival date of the Headcount if this is archived.

headcount-display-idstring nullable

Headcount ID

backfill-employee-emailstring nullable

Email of the backfill employee if this Headcount is a backfill.

headcount-denied-datestring nullable

Denied date of the Headcount if this is denied.

headcount-is-privateboolean nullable

Whether the Headcount is private.

actual-bonus-percnumber double nullable

Actual bonus-perc of the Headcount.

target-start-datestring nullable required

Target start date of the Headcount.

budget-start-datestring nullable

Budget start date of the Headcount.

is-currentboolean nullable

Whether the Headcount is included in current hiring plan or not.

divisionstring nullable required

Division of the Headcount.

employee-emailstring nullable

Employee email

budget-pay-ratestring nullable

Budget pay rate of the Headcount.

hris-employee-idstring nullable

HRIS Employee ID

job-levelstring nullable required

Job level of the Headcount.

job-namestring nullable

Job name of the Headcount - concatenation of ATS job-id and job name.

denied-justificationstring nullable

Justification of denial if the Headcount is denied.

hiring-plan-activeboolean nullable

Whether the Headcount is included in current hiring plan or not.

actual-salarynumber double nullable

Actual salary of the Headcount.

locationstring nullable required

Location of the Headcount.

employee-idstring uuid nullable

Employee ID.

reporting-manager-emailstring nullable

Email of the reporting manager.

last-updatedstring 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-currencystring nullable

Actual Equity currency of the Headcount.

status'Filled' | 'Approved' | 'Denied' | 'In Approval' | 'Archived' nullable

Current status of the Headcount.

actual-start-datestring nullable

Actual start date of the Headcount.

target-open-datestring nullable

Target open date of the Headcount.

pay-ratestring nullable

Pay rate of the Headcount.

target-bonusnumber double nullable

Target bonus of the Headcount.

budget-currencystring nullable

Budget currency of the Headcount.

job-titlestring nullable required

Job title of the Headcount.

future-terminationboolean nullable

Is the employee termination in future

backfill-employeestring nullable

Name of the backfill employee for this Headcount.

annualized-actual-salarynumber double nullable

Actual salary calculated annually.

backfill-employee-idstring nullable

Employee ID of backfilled employee for the Headcount.

track-managementstring nullable

Docker specific field

hris-employee-remote-idstring nullable

HRIS Remote Employee ID

target-salarynumber double nullable

Target salary of the Headcount.

target-currencystring nullable

Target currency of the Headcount.

hiring-planstring nullable

Name of the hiring plan

statestring nullable

Docker specific field

annualized-target-salarynumber double nullable

Target salary calculated annually for this Headcount.

employee-namestring nullable required

Name of the employee.

offer-sent-datestring nullable

Offer sent date for the headcount if exists.

actual-currencystring nullable

Actual currency of the Headcount.

budget-variablenumber double nullable

Budget variable of the Headcount.

pay-rate-multipliernumber double nullable

Pay rate multiplier of the Headcount.

termination-reconciledboolean nullable

Was the employee termination reconciled

job-rolestring nullable

Job role of the Headcount.

headcount-urlstring nullable

URL of the Headcount details in TeamOhana.

reporting-manager-hris-employee-idstring nullable

HRIS Employee ID of the Reporting manager of the employee

offer-accept-datestring nullable

Offer acceptance date for the headcount if exists.

teamstring nullable

Headcount's team name.

approval-requested-datestring nullable

Date of approval for this Headcount .

initiativestring nullable

Initiative name of the Headcount if exists.

job-functionstring nullable

Docker specific field

target-hire-datestring nullable

Target hire date of the Headcount.

target-pay-ratestring nullable

Target pay rate of the Headcount.

employment-end-datestring nullable

Employment end date for the headcount if exists.

teamohana-idstring nullable

Teamohana ID

coordinatorsstring nullable

Names of the coordinators split by ;

justificationstring nullable

Headcount Justification

termination-regrettableboolean nullable

Was the employee termination regrettable

Example response

[
  {
    "termination-date": "08-26-2024",
    "hiring-status": "Hired",
    "employee-type": "Full Time",
    "department": "Sales",
    "headcount-approved-date": "08-26-2024",
    "target-equity-currency": "USD",
    "priority": "Normal",
    "target-equity": 4321,
    "custom-fields": {
      "HEADCOUNT": {
        "Field 1": "Value 1",
        "Field 2": null,
        "Field 3": 123
      },
      "EMPLOYEE": {
        "Field 1": "Value 1",
        "Field 2": "Value 2",
        "Field 3": 321
      },
      "OFFER": {
        "Field 1": null,
        "Field 2": null,
        "Field 3": "Value 3"
      }
    },
    "opening-id": "1234-123",
    "budget-equity": 44000,
    "headcount-id": "ORG-123",
    "sourcers": "Stephen Marshall ; Mark Henry",
    "actual-bonus": 8484,
    "budget-salary": 205000,
    "reporting-manager": "Stephen Marshall",
    "termination-type": "Initiative Name",
    "recruiters": "Stephen Marshall ; Mark Henry",
    "annualized-budget-salary": 2460000,
    "target-bonus-perc": 10,
    "actual-equity": 4321,
    "actual-variable": 1324,
    "compensation-change-reason": "ABC",
    "budget-job-level": "L1",
    "headcount-type": "New hire",
    "id": "uuid",
    "archived-justification": "Not required",
    "archived-date": "08-26-2024",
    "headcount-display-id": "ABC-123",
    "backfill-employee-email": "ramzi.ali@example.com",
    "headcount-denied-date": "08-26-2024",
    "headcount-is-private": true,
    "actual-bonus-perc": 10,
    "target-start-date": "08-26-2024",
    "budget-start-date": "08-26-2024",
    "is-current": true,
    "division": "Engineering",
    "employee-email": "a@b.com",
    "budget-pay-rate": "YEAR",
    "hris-employee-id": "1234",
    "job-level": "L2",
    "job-name": "GH-1234 - Sales Director, Generative AI",
    "denied-justification": "Not Suitable",
    "hiring-plan-active": true,
    "location": "San francisco, USA",
    "employee-id": "uuid",
    "reporting-manager-email": "stephen.marshall@example.com",
    "last-updated": "2024-07-15T00:00:00Z",
    "headcount-status": "Approved",
    "actual-equity-currency": "USD",
    "status": "Approved",
    "actual-start-date": "08-26-2024",
    "target-open-date": "08-26-2024",
    "pay-rate": "YEAR",
    "target-bonus": 8484,
    "budget-currency": "USD",
    "job-title": "Software Engineer",
    "future-termination": true,
    "backfill-employee": "Ramzi Ali",
    "annualized-actual-salary": 28140,
    "backfill-employee-id": "1234",
    "track-management": "ABC",
    "hris-employee-remote-id": "1234",
    "target-salary": 84840,
    "target-currency": "USD",
    "hiring-plan": "FY Hiring plan 2025",
    "state": "S",
    "annualized-target-salary": 1018080,
    "employee-name": "Terry Peters",
    "offer-sent-date": "08-26-2024",
    "actual-currency": "USD",
    "budget-variable": 105000,
    "pay-rate-multiplier": 2080,
    "termination-reconciled": true,
    "job-role": "Marketing",
    "headcount-url": "https://app.teamohana.us/headcount-details/1949a6b5-eaeb-4ee3-8d3d-9c597b04c918",
    "reporting-manager-hris-employee-id": "1234",
    "offer-accept-date": "08-26-2024",
    "team": "Sales",
    "approval-requested-date": "08-26-2024",
    "initiative": "Initiative Name",
    "job-function": "ABC",
    "target-hire-date": "08-26-2024",
    "target-pay-rate": "YEAR",
    "employment-end-date": "08-26-2024",
    "teamohana-id": "TO-1234",
    "coordinators": "Stephen Marshall ; Mark Henry",
    "justification": "Need additional resource",
    "termination-regrettable": true
  }
]