Humaans
API integration

list_all_humaans_people

List all people in Humaans. An employee at the company — the central object in Humaans. Supports Humaans query filters and $limit/$skip pagination.

get_single_humaans_person_by_id

Retrieve a single person by its Humaans ID. An employee at the company — the central object in Humaans.

create_a_humaans_person

Create a new person in Humaans. An employee at the company — the central object in Humaans.

update_a_humaans_person_by_id

Update an existing person by its Humaans ID. Only the supplied fields are changed. An employee at the company — the central object in Humaans.

delete_a_humaans_person_by_id

Delete a person by its Humaans ID. An employee at the company — the central object in Humaans.

list_all_humaans_companies

List all companies in Humaans. A company (legal entity) configured in Humaans. Supports Humaans query filters and $limit/$skip pagination.

get_single_humaans_company_by_id

Retrieve a single company by its Humaans ID. A company (legal entity) configured in Humaans.

update_a_humaans_company_by_id

Update an existing company by its Humaans ID. Only the supplied fields are changed. A company (legal entity) configured in Humaans.

list_all_humaans_time_away

List all time away entries in Humaans. A time away (leave) entry for a person, including its per-day breakdown and approval status. Supports Humaans query filters and $limit/$skip pagination.

get_single_humaans_time_away_by_id

Retrieve a single time away entry by its Humaans ID. A time away (leave) entry for a person, including its per-day breakdown and approval status.

create_a_humaans_time_away

Create a new time away entry in Humaans. A time away (leave) entry for a person, including its per-day breakdown and approval status.

update_a_humaans_time_away_by_id

Update an existing time away entry by its Humaans ID. Only the supplied fields are changed. A time away (leave) entry for a person, including its per-day breakdown and approval status.

delete_a_humaans_time_away_by_id

Delete a time away entry by its Humaans ID. A time away (leave) entry for a person, including its per-day breakdown and approval status.

list_all_humaans_bank_accounts

List all bank accounts in Humaans. A person's bank account used for payroll. Supports Humaans query filters and $limit/$skip pagination.

get_single_humaans_bank_account_by_id

Retrieve a single bank account by its Humaans ID. A person's bank account used for payroll.

create_a_humaans_bank_account

Create a new bank account in Humaans. A person's bank account used for payroll.

update_a_humaans_bank_account_by_id

Update an existing bank account by its Humaans ID. Only the supplied fields are changed. A person's bank account used for payroll.

delete_a_humaans_bank_account_by_id

Delete a bank account by its Humaans ID. A person's bank account used for payroll.

list_all_humaans_locations

List all locations in Humaans. An office location that people can be assigned to. Supports Humaans query filters and $limit/$skip pagination.

get_single_humaans_location_by_id

Retrieve a single location by its Humaans ID. An office location that people can be assigned to.

create_a_humaans_location

Create a new location in Humaans. An office location that people can be assigned to.

update_a_humaans_location_by_id

Update an existing location by its Humaans ID. Only the supplied fields are changed. An office location that people can be assigned to.

delete_a_humaans_location_by_id

Delete a location by its Humaans ID. An office location that people can be assigned to.

list_all_humaans_time_away_periods

List all time away periods in Humaans. An accrual period for a time away policy. Supports Humaans query filters and $limit/$skip pagination.

list_all_humaans_job_roles

List all job roles in Humaans. A person's job role over time — job title, department and reporting line, with an effective date. Supports Humaans query filters and $limit/$skip pagination.

get_single_humaans_job_role_by_id

Retrieve a single job role by its Humaans ID. A person's job role over time — job title, department and reporting line, with an effective date.

create_a_humaans_job_role

Create a new job role in Humaans. A person's job role over time — job title, department and reporting line, with an effective date.

update_a_humaans_job_role_by_id

Update an existing job role by its Humaans ID. Only the supplied fields are changed. A person's job role over time — job title, department and reporting line, with an effective date.

delete_a_humaans_job_role_by_id

Delete a job role by its Humaans ID. A person's job role over time — job title, department and reporting line, with an effective date.

list_all_humaans_compensations

List all compensations in Humaans. A compensation entry for a person — amount, currency and period, with an effective date. Supports Humaans query filters and $limit/$skip pagination.

get_single_humaans_compensation_by_id

Retrieve a single compensation by its Humaans ID. A compensation entry for a person — amount, currency and period, with an effective date.

create_a_humaans_compensation

Create a new compensation in Humaans. A compensation entry for a person — amount, currency and period, with an effective date.

update_a_humaans_compensation_by_id

Update an existing compensation by its Humaans ID. Only the supplied fields are changed. A compensation entry for a person — amount, currency and period, with an effective date.

delete_a_humaans_compensation_by_id

Delete a compensation by its Humaans ID. A compensation entry for a person — amount, currency and period, with an effective date.

list_all_humaans_time_away_types

List all time away types in Humaans. A type of time away (e.g. holiday, sick leave) that entries are attached to. Supports Humaans query filters and $limit/$skip pagination.

get_single_humaans_time_away_type_by_id

Retrieve a single time away type by its Humaans ID. A type of time away (e.g. holiday, sick leave) that entries are attached to.

create_a_humaans_time_away_type

Create a new time away type in Humaans. A type of time away (e.g. holiday, sick leave) that entries are attached to.

update_a_humaans_time_away_type_by_id

Update an existing time away type by its Humaans ID. Only the supplied fields are changed. A type of time away (e.g. holiday, sick leave) that entries are attached to.

delete_a_humaans_time_away_type_by_id

Delete a time away type by its Humaans ID. A type of time away (e.g. holiday, sick leave) that entries are attached to.

list_all_humaans_compensation_types

List all compensation types in Humaans. A compensation type (e.g. salary, bonus, commission, equity) referenced by compensations. Supports Humaans query filters and $limit/$skip pagination.

get_single_humaans_compensation_type_by_id

Retrieve a single compensation type by its Humaans ID. A compensation type (e.g. salary, bonus, commission, equity) referenced by compensations.

list_all_humaans_custom_fields

List all custom fields in Humaans. A custom field definition configured on the account. Supports Humaans query filters and $limit/$skip pagination.

get_single_humaans_custom_field_by_id

Retrieve a single custom field by its Humaans ID. A custom field definition configured on the account.

create_a_humaans_custom_field

Create a new custom field in Humaans. A custom field definition configured on the account.

update_a_humaans_custom_field_by_id

Update an existing custom field by its Humaans ID. Only the supplied fields are changed. A custom field definition configured on the account.

delete_a_humaans_custom_field_by_id

Delete a custom field by its Humaans ID. A custom field definition configured on the account.

list_all_humaans_custom_values

List all custom values in Humaans. A value stored against a custom field for a person. Supports Humaans query filters and $limit/$skip pagination.

get_single_humaans_custom_value_by_id

Retrieve a single custom value by its Humaans ID. A value stored against a custom field for a person.

create_a_humaans_custom_value

Create a new custom value in Humaans. A value stored against a custom field for a person.

update_a_humaans_custom_value_by_id

Update an existing custom value by its Humaans ID. Only the supplied fields are changed. A value stored against a custom field for a person.

delete_a_humaans_custom_value_by_id

Delete a custom value by its Humaans ID. A value stored against a custom field for a person.

get_single_humaans_data_export_by_id

Retrieve a single data export by its Humaans ID. An asynchronous data export job.

create_a_humaans_data_export

Create a new data export in Humaans. An asynchronous data export job.

delete_a_humaans_data_export_by_id

Delete a data export by its Humaans ID. An asynchronous data export job.

list_all_humaans_document_types

List all document types in Humaans. A category that documents can be filed under. Supports Humaans query filters and $limit/$skip pagination.

create_a_humaans_document_type

Create a new document type in Humaans. A category that documents can be filed under.

update_a_humaans_document_type_by_id

Update an existing document type by its Humaans ID. Only the supplied fields are changed. A category that documents can be filed under.

delete_a_humaans_document_type_by_id

Delete a document type by its Humaans ID. A category that documents can be filed under.

list_all_humaans_documents

List all documents in Humaans. A document attached to a person or to the company. Supports Humaans query filters and $limit/$skip pagination.

get_single_humaans_document_by_id

Retrieve a single document by its Humaans ID. A document attached to a person or to the company.

create_a_humaans_document

Create a new document in Humaans. A document attached to a person or to the company.

update_a_humaans_document_by_id

Update an existing document by its Humaans ID. Only the supplied fields are changed. A document attached to a person or to the company.

delete_a_humaans_document_by_id

Delete a document by its Humaans ID. A document attached to a person or to the company.

list_all_humaans_emergency_contacts

List all emergency contacts in Humaans. A person's emergency contact. Supports Humaans query filters and $limit/$skip pagination.

get_single_humaans_emergency_contact_by_id

Retrieve a single emergency contact by its Humaans ID. A person's emergency contact.

create_a_humaans_emergency_contact

Create a new emergency contact in Humaans. A person's emergency contact.

update_a_humaans_emergency_contact_by_id

Update an existing emergency contact by its Humaans ID. Only the supplied fields are changed. A person's emergency contact.

delete_a_humaans_emergency_contact_by_id

Delete a emergency contact by its Humaans ID. A person's emergency contact.

list_all_humaans_equipment

List all equipment items in Humaans. A piece of company equipment assigned to a person. Supports Humaans query filters and $limit/$skip pagination.

get_single_humaans_equipment_by_id

Retrieve a single equipment item by its Humaans ID. A piece of company equipment assigned to a person.

create_a_humaans_equipment

Create a new equipment item in Humaans. A piece of company equipment assigned to a person.

update_a_humaans_equipment_by_id

Update an existing equipment item by its Humaans ID. Only the supplied fields are changed. A piece of company equipment assigned to a person.

delete_a_humaans_equipment_by_id

Delete a equipment item by its Humaans ID. A piece of company equipment assigned to a person.

list_all_humaans_equipment_names

List all equipment names in Humaans. A predefined equipment name option. Supports Humaans query filters and $limit/$skip pagination.

list_all_humaans_equipment_types

List all equipment types in Humaans. A predefined equipment type option. Supports Humaans query filters and $limit/$skip pagination.

get_single_humaans_file_by_id

Retrieve a single file by its Humaans ID. An uploaded file, referenced by documents, identity documents and profile photos.

create_a_humaans_file

Create a new file in Humaans. An uploaded file, referenced by documents, identity documents and profile photos.

list_all_humaans_identity_document_types

List all identity document types in Humaans. A type of identity document. Supports Humaans query filters and $limit/$skip pagination.

list_all_humaans_identity_documents

List all identity documents in Humaans. A person's identity document (e.g. passport, visa) with its expiry. Supports Humaans query filters and $limit/$skip pagination.

get_single_humaans_identity_document_by_id

Retrieve a single identity document by its Humaans ID. A person's identity document (e.g. passport, visa) with its expiry.

create_a_humaans_identity_document

Create a new identity document in Humaans. A person's identity document (e.g. passport, visa) with its expiry.

update_a_humaans_identity_document_by_id

Update an existing identity document by its Humaans ID. Only the supplied fields are changed. A person's identity document (e.g. passport, visa) with its expiry.

delete_a_humaans_identity_document_by_id

Delete a identity document by its Humaans ID. A person's identity document (e.g. passport, visa) with its expiry.

list_all_humaans_job_library_levels

List all job library levels in Humaans. A level in the job library. Supports Humaans query filters and $limit/$skip pagination.

get_single_humaans_job_library_level_by_id

Retrieve a single job library level by its Humaans ID. A level in the job library.

create_a_humaans_job_library_level

Create a new job library level in Humaans. A level in the job library.

update_a_humaans_job_library_level_by_id

Update an existing job library level by its Humaans ID. Only the supplied fields are changed. A level in the job library.

delete_a_humaans_job_library_level_by_id

Delete a job library level by its Humaans ID. A level in the job library.

list_all_humaans_job_library_profiles

List all job library profiles in Humaans. A job profile in the job library. Supports Humaans query filters and $limit/$skip pagination.

get_single_humaans_job_library_profile_by_id

Retrieve a single job library profile by its Humaans ID. A job profile in the job library.

create_a_humaans_job_library_profile

Create a new job library profile in Humaans. A job profile in the job library.

update_a_humaans_job_library_profile_by_id

Update an existing job library profile by its Humaans ID. Only the supplied fields are changed. A job profile in the job library.

delete_a_humaans_job_library_profile_by_id

Delete a job library profile by its Humaans ID. A job profile in the job library.

list_all_humaans_job_library_roles

List all job library roles in Humaans. A role in the job library. Supports Humaans query filters and $limit/$skip pagination.

get_single_humaans_job_library_role_by_id

Retrieve a single job library role by its Humaans ID. A role in the job library.

create_a_humaans_job_library_role

Create a new job library role in Humaans. A role in the job library.

update_a_humaans_job_library_role_by_id

Update an existing job library role by its Humaans ID. Only the supplied fields are changed. A role in the job library.

delete_a_humaans_job_library_role_by_id

Delete a job library role by its Humaans ID. A role in the job library.

list_all_humaans_me

Retrieve the person associated with the current API token.

list_all_humaans_org_hierarchies

List all org hierarchies in Humaans. An organisational hierarchy definition. Supports Humaans query filters and $limit/$skip pagination.

get_single_humaans_org_hierarchy_by_id

Retrieve a single org hierarchy by its Humaans ID. An organisational hierarchy definition.

list_all_humaans_org_unit_assignments

List all org unit assignments in Humaans. The assignment of a person to an org unit. Supports Humaans query filters and $limit/$skip pagination.

get_single_humaans_org_unit_assignment_by_id

Retrieve a single org unit assignment by its Humaans ID. The assignment of a person to an org unit.

list_all_humaans_org_units

List all org units in Humaans. A unit (e.g. department, division) within an org hierarchy. Supports Humaans query filters and $limit/$skip pagination.

get_single_humaans_org_unit_by_id

Retrieve a single org unit by its Humaans ID. A unit (e.g. department, division) within an org hierarchy.

list_all_humaans_performance_cycle_instances

List all performance cycle instances in Humaans. A person's instance of a performance cycle. Supports Humaans query filters and $limit/$skip pagination.

get_single_humaans_performance_cycle_instance_by_id

Retrieve a single performance cycle instance by its Humaans ID. A person's instance of a performance cycle.

list_all_humaans_performance_cycle_review_templates

List all performance cycle review templates in Humaans. A template used for reviews in a performance cycle. Supports Humaans query filters and $limit/$skip pagination.

get_single_humaans_performance_cycle_review_template_by_id

Retrieve a single performance cycle review template by its Humaans ID. A template used for reviews in a performance cycle.

list_all_humaans_performance_cycle_reviews

List all performance cycle reviews in Humaans. An individual review within a performance cycle. Supports Humaans query filters and $limit/$skip pagination.

get_single_humaans_performance_cycle_review_by_id

Retrieve a single performance cycle review by its Humaans ID. An individual review within a performance cycle.

list_all_humaans_performance_cycles

List all performance cycles in Humaans. A performance review cycle. Supports Humaans query filters and $limit/$skip pagination.

get_single_humaans_performance_cycle_by_id

Retrieve a single performance cycle by its Humaans ID. A performance review cycle.

list_all_humaans_public_holiday_calendar_days

List all public holiday calendar days in Humaans. A single day within a public holiday calendar. Supports Humaans query filters and $limit/$skip pagination.

get_single_humaans_public_holiday_calendar_day_by_id

Retrieve a single public holiday calendar day by its Humaans ID. A single day within a public holiday calendar.

create_a_humaans_public_holiday_calendar_day

Create a new public holiday calendar day in Humaans. A single day within a public holiday calendar.

update_a_humaans_public_holiday_calendar_day_by_id

Update an existing public holiday calendar day by its Humaans ID. Only the supplied fields are changed. A single day within a public holiday calendar.

list_all_humaans_public_holiday_calendars

List all public holiday calendars in Humaans. A public holiday calendar that people can be assigned to. Supports Humaans query filters and $limit/$skip pagination.

list_all_humaans_public_holidays

List all public holidays in Humaans. A public holiday observed on a calendar. Supports Humaans query filters and $limit/$skip pagination.

list_all_humaans_spaces

List all spaces in Humaans. A Space, used to segment people into separate areas of the organisation. Supports Humaans query filters and $limit/$skip pagination.

get_single_humaans_space_by_id

Retrieve a single space by its Humaans ID. A Space, used to segment people into separate areas of the organisation.

create_a_humaans_space

Create a new space in Humaans. A Space, used to segment people into separate areas of the organisation.

update_a_humaans_space_by_id

Update an existing space by its Humaans ID. Only the supplied fields are changed. A Space, used to segment people into separate areas of the organisation.

delete_a_humaans_space_by_id

Delete a space by its Humaans ID. A Space, used to segment people into separate areas of the organisation.

list_all_humaans_time_away_adjustments

List all time away adjustments in Humaans. A manual adjustment to a person's time away balance. Supports Humaans query filters and $limit/$skip pagination.

get_single_humaans_time_away_adjustment_by_id

Retrieve a single time away adjustment by its Humaans ID. A manual adjustment to a person's time away balance.

create_a_humaans_time_away_adjustment

Create a new time away adjustment in Humaans. A manual adjustment to a person's time away balance.

update_a_humaans_time_away_adjustment_by_id

Update an existing time away adjustment by its Humaans ID. Only the supplied fields are changed. A manual adjustment to a person's time away balance.

delete_a_humaans_time_away_adjustment_by_id

Delete a time away adjustment by its Humaans ID. A manual adjustment to a person's time away balance.

list_all_humaans_time_away_allocations

List all time away allocations in Humaans. An allocation of time away entitlement to a person. Supports Humaans query filters and $limit/$skip pagination.

get_single_humaans_time_away_allocation_by_id

Retrieve a single time away allocation by its Humaans ID. An allocation of time away entitlement to a person.

create_a_humaans_time_away_allocation

Create a new time away allocation in Humaans. An allocation of time away entitlement to a person.

update_a_humaans_time_away_allocation_by_id

Update an existing time away allocation by its Humaans ID. Only the supplied fields are changed. An allocation of time away entitlement to a person.

delete_a_humaans_time_away_allocation_by_id

Delete a time away allocation by its Humaans ID. An allocation of time away entitlement to a person.

list_all_humaans_time_away_policies

List all time away policies in Humaans. A policy governing accrual and allowance for a time away type. Supports Humaans query filters and $limit/$skip pagination.

get_single_humaans_time_away_policy_by_id

Retrieve a single time away policy by its Humaans ID. A policy governing accrual and allowance for a time away type.

create_a_humaans_time_away_policy

Create a new time away policy in Humaans. A policy governing accrual and allowance for a time away type.

update_a_humaans_time_away_policy_by_id

Update an existing time away policy by its Humaans ID. Only the supplied fields are changed. A policy governing accrual and allowance for a time away type.

delete_a_humaans_time_away_policy_by_id

Delete a time away policy by its Humaans ID. A policy governing accrual and allowance for a time away type.

list_all_humaans_timesheet_entries

List all timesheet entries in Humaans. A recorded block of worked time for a person. Supports Humaans query filters and $limit/$skip pagination.

get_single_humaans_timesheet_entry_by_id

Retrieve a single timesheet entry by its Humaans ID. A recorded block of worked time for a person.

create_a_humaans_timesheet_entry

Create a new timesheet entry in Humaans. A recorded block of worked time for a person.

update_a_humaans_timesheet_entry_by_id

Update an existing timesheet entry by its Humaans ID. Only the supplied fields are changed. A recorded block of worked time for a person.

delete_a_humaans_timesheet_entry_by_id

Delete a timesheet entry by its Humaans ID. A recorded block of worked time for a person.

list_all_humaans_timesheet_submissions

List all timesheet submissions in Humaans. A person's timesheet submitted for approval. Supports Humaans query filters and $limit/$skip pagination.

get_single_humaans_timesheet_submission_by_id

Retrieve a single timesheet submission by its Humaans ID. A person's timesheet submitted for approval.

create_a_humaans_timesheet_submission

Create a new timesheet submission in Humaans. A person's timesheet submitted for approval.

update_a_humaans_timesheet_submission_by_id

Update an existing timesheet submission by its Humaans ID. Only the supplied fields are changed. A person's timesheet submitted for approval.

delete_a_humaans_timesheet_submission_by_id

Delete a timesheet submission by its Humaans ID. A person's timesheet submitted for approval.

list_all_humaans_token_info

Retrieve the scopes granted to the current API token.

list_all_humaans_webhooks

List all webhooks in Humaans. A webhook subscription delivering Humaans events to an endpoint. Supports Humaans query filters and $limit/$skip pagination.

get_single_humaans_webhook_by_id

Retrieve a single webhook by its Humaans ID. A webhook subscription delivering Humaans events to an endpoint.

create_a_humaans_webhook

Create a new webhook in Humaans. A webhook subscription delivering Humaans events to an endpoint.

update_a_humaans_webhook_by_id

Update an existing webhook by its Humaans ID. Only the supplied fields are changed. A webhook subscription delivering Humaans events to an endpoint.

delete_a_humaans_webhook_by_id

Delete a webhook by its Humaans ID. A webhook subscription delivering Humaans events to an endpoint.

list_all_humaans_working_pattern_allocations

List all working pattern allocations in Humaans. The assignment of a working pattern to a person for a period. Supports Humaans query filters and $limit/$skip pagination.

get_single_humaans_working_pattern_allocation_by_id

Retrieve a single working pattern allocation by its Humaans ID. The assignment of a working pattern to a person for a period.

create_a_humaans_working_pattern_allocation

Create a new working pattern allocation in Humaans. The assignment of a working pattern to a person for a period.

update_a_humaans_working_pattern_allocation_by_id

Update an existing working pattern allocation by its Humaans ID. Only the supplied fields are changed. The assignment of a working pattern to a person for a period.

delete_a_humaans_working_pattern_allocation_by_id

Delete a working pattern allocation by its Humaans ID. The assignment of a working pattern to a person for a period.

list_all_humaans_working_patterns

List all working patterns in Humaans. A reusable definition of the days and hours worked. Supports Humaans query filters and $limit/$skip pagination.

get_single_humaans_working_pattern_by_id

Retrieve a single working pattern by its Humaans ID. A reusable definition of the days and hours worked.

create_a_humaans_working_pattern

Create a new working pattern in Humaans. A reusable definition of the days and hours worked.

update_a_humaans_working_pattern_by_id

Update an existing working pattern by its Humaans ID. Only the supplied fields are changed. A reusable definition of the days and hours worked.

delete_a_humaans_working_pattern_by_id

Delete a working pattern by its Humaans ID. A reusable definition of the days and hours worked.