API - Corsair

Every breathehr.api.* operation is listed below with parameter shapes and return types from the plugin Zod schemas.

New to Corsair? See API access, authentication, and error handling.

Absences

list

absences.list List absences Risk: read

await corsair.breathehr.api.absences.list({});

Input

Name	Type	Required	Description
`page`	`number`	No	—
`per_page`	`number`	No	—
`type`	`Holiday \| OtherLeave`	No	—
`end_date`	`string`	No	—
`start_date`	`string`	No	—
`rotacloud`	`boolean`	No	—
`employee_id`	`number`	No	—
`department_id`	`number`	No	—
`other_leave_reason_id`	`number`	No	—
`exclude_cancelled_absences`	`boolean`	No	—

Output

Name	Type	Required	Description
`absences`	`object[]`	No	—

absences full type

{
  id?: number,
  start_date?: string,
  end_date?: string,
  type?: string
}[]

Account

get

account.get Retrieve Breathe HR account details Risk: read

await corsair.breathehr.api.account.get({});

Input: empty object Output

Name	Type	Required	Description
`account`	`object`	No	—

account full type

{
  id?: number,
  name?: string,
  domain?: string,
  uuid?: string,
  using_rta?: boolean,
  health_and_safety_enabled?: boolean
}

Benefits

list

benefits.list List employee benefits Risk: read

await corsair.breathehr.api.benefits.list({});

Input

Name	Type	Required	Description
`page`	`number`	No	—
`per_page`	`number`	No	—

Output: empty object

Bonuses

list

bonuses.list List employee bonuses Risk: read

await corsair.breathehr.api.bonuses.list({});

Input

Name	Type	Required	Description
`page`	`number`	No	—
`per_page`	`number`	No	—

Output: empty object

Change Requests

list

changeRequests.list List change requests Risk: read

await corsair.breathehr.api.changeRequests.list({});

Input

Name	Type	Required	Description
`page`	`number`	No	—
`per_page`	`number`	No	—

Output: empty object

Company Documents

list

companyDocuments.list List company documents Risk: read

await corsair.breathehr.api.companyDocuments.list({});

Input

Name	Type	Required	Description
`page`	`number`	No	—
`per_page`	`number`	No	—

Output: empty object

Company Projects

list

companyProjects.list List company projects Risk: read

await corsair.breathehr.api.companyProjects.list({});

Input

Name	Type	Required	Description
`page`	`number`	No	—
`per_page`	`number`	No	—

Output: empty object

Company Training Types

list

companyTrainingTypes.list List company training types Risk: read

await corsair.breathehr.api.companyTrainingTypes.list({});

Input

Name	Type	Required	Description
`page`	`number`	No	—
`per_page`	`number`	No	—

Output: empty object

Departments

list

departments.list List departments Risk: read

await corsair.breathehr.api.departments.list({});

Input

Name	Type	Required	Description
`page`	`number`	No	—
`per_page`	`number`	No	—

Output: empty object

listAbsences

departments.listAbsences List absences for a department Risk: read

await corsair.breathehr.api.departments.listAbsences({});

Input

Name	Type	Required	Description
`id`	`number \| string`	Yes	—
`page`	`number`	No	—
`per_page`	`number`	No	—
`exclude_cancelled_absences`	`boolean`	No	—

Output

Name	Type	Required	Description
`absences`	`object[]`	No	—

absences full type

{
  id?: number,
  start_date?: string,
  end_date?: string,
  type?: string
}[]

listBenefits

departments.listBenefits List benefits for a department Risk: read

await corsair.breathehr.api.departments.listBenefits({});

Input

Name	Type	Required	Description
`id`	`number \| string`	Yes	—
`page`	`number`	No	—
`per_page`	`number`	No	—

Output: empty object

listBonuses

departments.listBonuses List bonuses for a department Risk: read

await corsair.breathehr.api.departments.listBonuses({});

Input

Name	Type	Required	Description
`id`	`number \| string`	Yes	—
`page`	`number`	No	—
`per_page`	`number`	No	—

Output: empty object

listLeaveRequests

departments.listLeaveRequests List leave requests for a department Risk: read

await corsair.breathehr.api.departments.listLeaveRequests({});

Input

Name	Type	Required	Description
`id`	`number`	Yes	—
`page`	`number`	No	—
`per_page`	`number`	No	—
`exclude_cancelled_requests`	`boolean`	No	—

Output

Name	Type	Required	Description
`leave_requests`	`object[]`	No	—

leave_requests full type

{
  id?: number,
  start_date?: string,
  end_date?: string,
  type?: string,
  status?: string,
  notes?: string | null
}[]

listSalaries

departments.listSalaries List salaries for a department Risk: read

await corsair.breathehr.api.departments.listSalaries({});

Input

Name	Type	Required	Description
`id`	`number \| string`	Yes	—
`page`	`number`	No	—
`per_page`	`number`	No	—

Output: empty object

Divisions

list

divisions.list List divisions Risk: read

await corsair.breathehr.api.divisions.list({});

Input: empty object Output: empty object

Employee Expense Claims

list

employeeExpenseClaims.list List employee expense claims Risk: read

await corsair.breathehr.api.employeeExpenseClaims.list({});

Input

Name	Type	Required	Description
`page`	`number`	No	—
`per_page`	`number`	No	—
`employee_id`	`number`	No	—
`state_filter`	`submitted \| approved \| completed`	No	—

Output: empty object

update

employeeExpenseClaims.update Approve or reject an expense claim Risk: write

await corsair.breathehr.api.employeeExpenseClaims.update({});

Input

Name	Type	Required	Description
`id`	`number`	Yes	—
`approve`	`boolean`	Yes	—
`approver_rejector_id`	`number`	Yes	—
`rejection_reason`	`string`	No	—

Output: object

Output full type

{
}

Employee Expenses

delete

employeeExpenses.delete Delete an employee expense Risk: destructive

await corsair.breathehr.api.employeeExpenses.delete({});

Input

Name	Type	Required	Description
`id`	`number`	Yes	—

Output

Name	Type	Required	Description
`deleted`	`boolean`	No	—

get

employeeExpenses.get Get an employee expense by ID Risk: read

await corsair.breathehr.api.employeeExpenses.get({});

Input

Name	Type	Required	Description
`id`	`number`	Yes	—

Output

Name	Type	Required	Description
`employee_expenses`	`object[]`	No	—

employee_expenses full type

{
  id?: number,
  amount?: number | string,
  description?: string,
  expense_date?: string
}[]

list

employeeExpenses.list List employee expenses Risk: read

await corsair.breathehr.api.employeeExpenses.list({});

Input

Name	Type	Required	Description
`page`	`number`	No	—
`per_page`	`number`	No	—
`employee_id`	`number`	No	—
`show_claimed`	`boolean`	No	—

Output

Name	Type	Required	Description
`employee_expenses`	`object[]`	No	—

employee_expenses full type

{
  id?: number,
  amount?: number | string,
  description?: string,
  expense_date?: string
}[]

Employee Jobs

list

employeeJobs.list List employee jobs Risk: read

await corsair.breathehr.api.employeeJobs.list({});

Input

Name	Type	Required	Description
`page`	`number`	No	—
`per_page`	`number`	No	—
`employee_id`	`number`	No	—

Output: empty object

Employees

create

employees.create Create an employee Risk: write

await corsair.breathehr.api.employees.create({});

Input

Name	Type	Required	Description
`first_name`	`string`	Yes	—
`last_name`	`string`	Yes	—
`email`	`string`	Yes	—
`company_join_date`	`string`	No	—
`join_date`	`string`	No	—
`job_title`	`string`	No	—
`job_start_date`	`string`	No	—
`hr`	`boolean`	No	—
`dob`	`string`	No	—
`gender`	`string`	No	—
`status`	`string`	No	—
`person_type`	`string`	No	—
`department`	`number`	No	—
`division`	`number`	No	—
`location`	`number`	No	—
`working_pattern`	`number`	No	—
`working_pattern_id`	`number`	No	—
`holiday_allowance`	`number`	No	—
`holiday_allowance_id`	`number`	No	—
`middle_name`	`string`	No	—
`work_mobile`	`string`	No	—
`home_telephone`	`string`	No	—
`personal_mobile`	`string`	No	—
`employee_ref`	`string`	No	—
`full_or_part_time`	`string`	No	—
`receives_statutory_holidays`	`boolean`	No	—

Output

Name	Type	Required	Description
`employees`	`object[]`	No	—

employees full type

{
  id?: number,
  account_id?: number,
  first_name?: string,
  last_name?: string,
  email?: string | null,
  job_title?: string | null,
  status?: string,
  join_date?: string,
  company_join_date?: string,
  job_start_date?: string | null,
  department?: {
    id?: number | string,
    name?: string
  } | null,
  division?: {
    id?: number | string,
    name?: string
  } | null,
  location?: {
    id?: number | string,
    name?: string
  } | null,
  working_pattern?: {
    id?: number | string,
    name?: string
  } | null,
  holiday_allowance?: {
    id?: number | string,
    name?: string
  } | null,
  line_manager?: {
    id?: number | string,
    name?: string
  } | null,
  hr?: boolean,
  created_at?: string,
  updated_at?: string
}[]

createChangeRequest

employees.createChangeRequest Create an employee change request Risk: write

await corsair.breathehr.api.employees.createChangeRequest({});

Input

Name	Type	Required	Description
`id`	`number \| string`	Yes	—
`field`	`string`	Yes	—
`value`	`string`	Yes	—
`approved`	`boolean`	No	—

Output: object

Output full type

{
}

createExpense

employees.createExpense Create an employee expense Risk: write

await corsair.breathehr.api.employees.createExpense({});

Input

Name	Type	Required	Description
`employee_id`	`number`	Yes	—
`amount`	`number`	Yes	—
`description`	`string`	Yes	—
`expense_date`	`string`	Yes	—
`payable_to_employee`	`boolean`	Yes	—
`company_expense_type_id`	`number`	Yes	—
`vat`	`number`	No	—
`miles`	`number`	No	—
`client_name`	`string`	No	—
`has_receipt`	`boolean`	No	—
`company_project_id`	`number`	No	—
`chargeable_to_client`	`boolean`	No	—
`company_mileage_rate_id`	`number`	No	—

Output

Name	Type	Required	Description
`employee_expenses`	`object[]`	No	—

employee_expenses full type

{
  id?: number,
  amount?: number | string,
  description?: string,
  expense_date?: string
}[]

createExpenseClaim

employees.createExpenseClaim Create an employee expense claim Risk: write

await corsair.breathehr.api.employees.createExpenseClaim({});

Input

Name	Type	Required	Description
`employee_id`	`number`	Yes	—
`employee_expense_ids`	`number[]`	Yes	—

Output: object

Output full type

{
}

createSickness

employees.createSickness Create an employee sickness record Risk: write

await corsair.breathehr.api.employees.createSickness({});

Input

Name	Type	Required	Description
`id`	`number`	Yes	—
`start_date`	`string`	Yes	—
`company_sicknesstype_id`	`number`	Yes	—
`reason`	`string`	No	—
`status`	`string`	No	—
`end_date`	`string`	No	—
`half_day`	`boolean`	No	—
`half_end`	`boolean`	No	—
`half_start`	`boolean`	No	—
`review_notes`	`string`	No	—
`half_end_am_pm`	`am \| pm`	No	—
`half_start_am_pm`	`am \| pm`	No	—

Output

Name	Type	Required	Description
`sicknesses`	`object[]`	No	—

sicknesses full type

{
  id?: number,
  start_date?: string,
  end_date?: string | null,
  status?: string,
  reason?: string
}[]

get

employees.get Get an employee by ID Risk: read

await corsair.breathehr.api.employees.get({});

Input

Name	Type	Required	Description
`id`	`number`	Yes	—

Output

Name	Type	Required	Description
`employees`	`object[]`	No	—

employees full type

{
  id?: number,
  account_id?: number,
  first_name?: string,
  last_name?: string,
  email?: string | null,
  job_title?: string | null,
  status?: string,
  join_date?: string,
  company_join_date?: string,
  job_start_date?: string | null,
  department?: {
    id?: number | string,
    name?: string
  } | null,
  division?: {
    id?: number | string,
    name?: string
  } | null,
  location?: {
    id?: number | string,
    name?: string
  } | null,
  working_pattern?: {
    id?: number | string,
    name?: string
  } | null,
  holiday_allowance?: {
    id?: number | string,
    name?: string
  } | null,
  line_manager?: {
    id?: number | string,
    name?: string
  } | null,
  hr?: boolean,
  created_at?: string,
  updated_at?: string
}[]

list

employees.list List employees with pagination Risk: read

await corsair.breathehr.api.employees.list({});

Input

Name	Type	Required	Description
`page`	`number`	No	—
`per_page`	`number`	No	—
`filter`	`hr \| line_manager \| either`	No	—
`rotacloud`	`boolean`	No	—

Output

Name	Type	Required	Description
`employees`	`object[]`	No	—

employees full type

{
  id?: number,
  account_id?: number,
  first_name?: string,
  last_name?: string,
  email?: string | null,
  job_title?: string | null,
  status?: string,
  join_date?: string,
  company_join_date?: string,
  job_start_date?: string | null,
  department?: {
    id?: number | string,
    name?: string
  } | null,
  division?: {
    id?: number | string,
    name?: string
  } | null,
  location?: {
    id?: number | string,
    name?: string
  } | null,
  working_pattern?: {
    id?: number | string,
    name?: string
  } | null,
  holiday_allowance?: {
    id?: number | string,
    name?: string
  } | null,
  line_manager?: {
    id?: number | string,
    name?: string
  } | null,
  hr?: boolean,
  created_at?: string,
  updated_at?: string
}[]

listAbsences

employees.listAbsences List absences for an employee Risk: read

await corsair.breathehr.api.employees.listAbsences({});

Input

Name	Type	Required	Description
`id`	`number`	Yes	—
`page`	`number`	No	—
`per_page`	`number`	No	—
`exclude_cancelled_absences`	`boolean`	No	—

Output

Name	Type	Required	Description
`absences`	`object[]`	No	—

absences full type

{
  id?: number,
  start_date?: string,
  end_date?: string,
  type?: string
}[]

listBenefits

employees.listBenefits List benefits for an employee Risk: read

await corsair.breathehr.api.employees.listBenefits({});

Input

Name	Type	Required	Description
`id`	`number \| string`	Yes	—
`page`	`number`	No	—
`per_page`	`number`	No	—

Output: empty object

listBonuses

employees.listBonuses List bonuses for an employee Risk: read

await corsair.breathehr.api.employees.listBonuses({});

Input

Name	Type	Required	Description
`id`	`number \| string`	Yes	—
`page`	`number`	No	—
`per_page`	`number`	No	—

Output: empty object

listChangeRequests

employees.listChangeRequests List change requests for an employee Risk: read

await corsair.breathehr.api.employees.listChangeRequests({});

Input

Name	Type	Required	Description
`id`	`number \| string`	Yes	—
`page`	`number`	No	—
`per_page`	`number`	No	—

Output: empty object

listHolidayYears

employees.listHolidayYears List holiday years for an employee Risk: read

await corsair.breathehr.api.employees.listHolidayYears({});

Input

Name	Type	Required	Description
`id`	`number`	Yes	—
`for_date`	`string`	No	—

Output: empty object

listLeaveRequests

employees.listLeaveRequests List leave requests for an employee Risk: read

await corsair.breathehr.api.employees.listLeaveRequests({});

Input

Name	Type	Required	Description
`id`	`number`	Yes	—
`exclude_cancelled_requests`	`boolean`	No	—

Output

Name	Type	Required	Description
`leave_requests`	`object[]`	No	—

leave_requests full type

{
  id?: number,
  start_date?: string,
  end_date?: string,
  type?: string,
  status?: string,
  notes?: string | null
}[]

listSalaries

employees.listSalaries List salaries for an employee Risk: read

await corsair.breathehr.api.employees.listSalaries({});

Input

Name	Type	Required	Description
`id`	`number \| string`	Yes	—
`page`	`number`	No	—
`per_page`	`number`	No	—

Output: empty object

Employee Training Courses

delete

employeeTrainingCourses.delete Delete an employee training course Risk: destructive

await corsair.breathehr.api.employeeTrainingCourses.delete({});

Input

Name	Type	Required	Description
`id`	`number \| string`	Yes	—

Output

Name	Type	Required	Description
`deleted`	`boolean`	No	—

list

employeeTrainingCourses.list List employee training courses Risk: read

await corsair.breathehr.api.employeeTrainingCourses.list({});

Input

Name	Type	Required	Description
`page`	`number`	No	—
`per_page`	`number`	No	—
`employee_id`	`number`	No	—

Output: empty object

update

employeeTrainingCourses.update Update an employee training course Risk: write

await corsair.breathehr.api.employeeTrainingCourses.update({});

Input

Name	Type	Required	Description
`id`	`number \| string`	Yes	—
`cost`	`string`	No	—
`name`	`string`	No	—
`notes`	`string`	No	—
`end_on`	`string`	No	—
`status`	`string`	No	—
`outcome`	`string`	No	—
`half_day`	`boolean`	No	—
`start_on`	`string`	No	—
`followup_date`	`string`	No	—
`half_day_am_pm`	`am \| pm`	No	—
`company_training_type_id`	`number`	No	—
`remuneration_currency_id`	`number`	No	—
`company_training_category_id`	`number`	No	—
`company_training_provider_id`	`number`	No	—

Output: object

Output full type

{
}

Holiday Allowances

list

holidayAllowances.list List holiday allowances Risk: read

await corsair.breathehr.api.holidayAllowances.list({});

Input: empty object Output: empty object

Leave Requests

approve

leaveRequests.approve Approve a leave request Risk: write

await corsair.breathehr.api.leaveRequests.approve({});

Input

Name	Type	Required	Description
`id`	`number`	Yes	—

Output

Name	Type	Required	Description
`leave_requests`	`object[]`	No	—

leave_requests full type

{
  id?: number,
  start_date?: string,
  end_date?: string,
  type?: string,
  status?: string,
  notes?: string | null
}[]

get

leaveRequests.get Get a leave request by ID Risk: read

await corsair.breathehr.api.leaveRequests.get({});

Input

Name	Type	Required	Description
`id`	`number`	Yes	—

Output

Name	Type	Required	Description
`leave_requests`	`object[]`	No	—

leave_requests full type

{
  id?: number,
  start_date?: string,
  end_date?: string,
  type?: string,
  status?: string,
  notes?: string | null
}[]

getCancelling

leaveRequests.getCancelling Get the leave request being cancelled Risk: read

await corsair.breathehr.api.leaveRequests.getCancelling({});

Input

Name	Type	Required	Description
`id`	`number`	Yes	—

Output

Name	Type	Required	Description
`leave_requests`	`object[]`	No	—

leave_requests full type

{
  id?: number,
  start_date?: string,
  end_date?: string,
  type?: string,
  status?: string,
  notes?: string | null
}[]

list

leaveRequests.list List leave requests Risk: read

await corsair.breathehr.api.leaveRequests.list({});

Input

Name	Type	Required	Description
`page`	`number`	No	—
`per_page`	`number`	No	—
`end_date`	`string`	No	—
`start_date`	`string`	No	—
`rotacloud`	`boolean`	No	—
`employee_id`	`number`	No	—
`department_id`	`number`	No	—
`exclude_cancelled_requests`	`boolean`	No	—

Output

Name	Type	Required	Description
`leave_requests`	`object[]`	No	—

leave_requests full type

{
  id?: number,
  start_date?: string,
  end_date?: string,
  type?: string,
  status?: string,
  notes?: string | null
}[]

reject

leaveRequests.reject Reject a leave request Risk: write

await corsair.breathehr.api.leaveRequests.reject({});

Input

Name	Type	Required	Description
`id`	`number`	Yes	—
`rejection_reason`	`string`	Yes	—

Output

Name	Type	Required	Description
`leave_requests`	`object[]`	No	—

leave_requests full type

{
  id?: number,
  start_date?: string,
  end_date?: string,
  type?: string,
  status?: string,
  notes?: string | null
}[]

Locations

list

locations.list List locations Risk: read

await corsair.breathehr.api.locations.list({});

Input

Name	Type	Required	Description
`page`	`number`	No	—
`per_page`	`number`	No	—

Output: empty object

Other Leave Reasons

list

otherLeaveReasons.list List other leave reasons Risk: read

await corsair.breathehr.api.otherLeaveReasons.list({});

Input: empty object Output: empty object

Salaries

list

salaries.list List salaries Risk: read

await corsair.breathehr.api.salaries.list({});

Input

Name	Type	Required	Description
`page`	`number`	No	—
`per_page`	`number`	No	—

Output: empty object

Sicknesses

list

sicknesses.list List sickness records Risk: read

await corsair.breathehr.api.sicknesses.list({});

Input

Name	Type	Required	Description
`page`	`number`	No	—
`per_page`	`number`	No	—
`end_date`	`string`	No	—
`start_date`	`string`	No	—
`rotacloud`	`boolean`	No	—
`employee_id`	`number`	No	—
`department_id`	`number`	No	—

Output

Name	Type	Required	Description
`sicknesses`	`object[]`	No	—

sicknesses full type

{
  id?: number,
  start_date?: string,
  end_date?: string | null,
  status?: string,
  reason?: string
}[]

update

sicknesses.update Update a sickness record Risk: write

await corsair.breathehr.api.sicknesses.update({});

Input

Name	Type	Required	Description
`id`	`number`	Yes	—
`reason`	`string`	No	—
`status`	`string`	No	—
`end_date`	`string`	No	—
`half_day`	`boolean`	No	—
`half_end`	`boolean`	No	—
`half_start`	`boolean`	No	—
`start_date`	`string`	No	—
`review_notes`	`string`	No	—
`half_end_am_pm`	`am \| pm`	No	—
`half_start_am_pm`	`am \| pm`	No	—
`company_sicknesstype_id`	`number`	No	—

Output

Name	Type	Required	Description
`sicknesses`	`object[]`	No	—

sicknesses full type

{
  id?: number,
  start_date?: string,
  end_date?: string | null,
  status?: string,
  reason?: string
}[]

Working Patterns

list

workingPatterns.list List working patterns Risk: read

await corsair.breathehr.api.workingPatterns.list({});

Input

Name	Type	Required	Description
`page`	`number`	No	—
`per_page`	`number`	No	—

Output: empty object

​Absences

​list

​Account

​get

​Benefits

​list

​Bonuses

​list

​Change Requests

​list

​Company Documents

​list

​Company Projects

​list

​Company Training Types

​list

​Departments

​list

​listAbsences

​listBenefits

​listBonuses

​listLeaveRequests

​listSalaries

​Divisions

​list

​Employee Expense Claims

​list

​update

​Employee Expenses

​delete

​get

​list

​Employee Jobs

​list

​Employees

​create

​createChangeRequest

​createExpense

​createExpenseClaim

​createSickness

​get

​list

​listAbsences

​listBenefits

​listBonuses

​listChangeRequests

​listHolidayYears

​listLeaveRequests

​listSalaries

​Employee Training Courses

​delete

​list

​update

​Holiday Allowances

​list

​Leave Requests

​approve

​get

​getCancelling

​list

​reject

​Locations

​list

​Other Leave Reasons

​list

​Salaries

​list

​Sicknesses

​list

​update

​Working Patterns

​list

Absences

list

Account

get

Benefits

list

Bonuses

list

Change Requests

list

Company Documents

list

Company Projects

list

Company Training Types

list

Departments

list

listAbsences

listBenefits

listBonuses

listLeaveRequests

listSalaries

Divisions

list

Employee Expense Claims

list

update

Employee Expenses

delete

get

list

Employee Jobs

list

Employees

create

createChangeRequest

createExpense

createExpenseClaim

createSickness

get

list

listAbsences

listBenefits

listBonuses

listChangeRequests

listHolidayYears

listLeaveRequests

listSalaries

Employee Training Courses

delete

list

update

Holiday Allowances

list

Leave Requests

approve

get

getCancelling

list

reject

Locations

list

Other Leave Reasons

list

Salaries

list

Sicknesses

list

update

Working Patterns

list