> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Humaans

> How to set up the Humaans connector, plus the actions that are available.

![Humaans](https://stackone-logos.com/api/humaans/filled/svg)

v1.1.1[See changelog](https://docs.stackone.com/connectors/humaans/changelog.md)

[117 actions](#actions) · 1 auth method

HRIS

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [API Key · Connector Profile](https://docs.stackone.com/connectors/humaans/guides/connector-profile/api-key.md)
>
> Uses an API access token created in Humaans. Access is limited to the scopes selected when the token is created.

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [API Key · Link Account](https://docs.stackone.com/connectors/humaans/guides/link-account/api-key.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

Scopes

Select all
|
Clear

compensations:read

compensations:write

documents:read

documents:write

private:read

private:write

public:read

webhooks:manage

No scopes found

117 actions

ActionDescriptionRequired scopes

List All Bank Accounts`humaans_list_bank_accounts`

List all bank accounts

`public:read`

Retrieve A Bank Account`humaans_get_bank_account`

Retrieve a bank account

`public:read`

Create A Bank Account`humaans_create_bank_account`

Create a bank account

`private:write`

Update A Bank Account`humaans_update_bank_account`

Update a bank account

`private:write`

Delete A Bank Account`humaans_delete_bank_account`

Delete a bank account

`private:write`

List All Companies`humaans_list_companies`

List all companies

`public:read`

Retrieve A Company`humaans_get_company`

Retrieve a company

`public:read`

Update A Company`humaans_update_company`

Update a company

`private:write`

List All Compensation Types`humaans_list_compensation_types`

List all compensation types

`public:read`

Retrieve A Compensation Type`humaans_get_compensation_type`

Retrieve a compensation type

`public:read`

List All Compensations`humaans_list_compensations`

List all compensations

`compensations:read`

Retrieve A Compensation`humaans_get_compensation`

Retrieve a compensation

`compensations:read`

Create A Compensation`humaans_create_compensation`

Create a compensation

`compensations:write`

Update A Compensation`humaans_update_compensation`

Update a compensation

`compensations:write`

Delete A Compensation`humaans_delete_compensation`

Delete a compensation

`compensations:write`

List All Custom Fields`humaans_list_custom_fields`

List all custom fields

`private:read`

Retrieve A Custom Field`humaans_get_custom_field`

Retrieve a custom field

`private:read`

Create A Custom Field`humaans_create_custom_field`

Create a custom field

`private:write`

Update A Custom Field`humaans_update_custom_field`

Update a custom field

`private:write`

Delete A Custom Field`humaans_delete_custom_field`

Delete a custom field

`private:write`

List All Custom Values`humaans_list_custom_values`

List all custom values

`private:read`

Retrieve A Custom Value`humaans_get_custom_value`

Retrieve a custom value

`private:read`

Create A Custom Value`humaans_create_custom_value`

Create a custom value

`private:write`

Update A Custom Value`humaans_update_custom_value`

Update a custom value

`private:write`

Delete A Custom Value`humaans_delete_custom_value`

Delete a custom value

`private:write`

List All Document Types`humaans_list_document_types`

List all document types

`documents:read`

Create A Document Type`humaans_create_document_type`

Create a document type

`documents:write`

Update A Document Type`humaans_update_document_type`

Update a document type

`documents:write`

List All Documents`humaans_list_documents`

List all documents

`documents:read`

Retrieve A Document`humaans_get_document`

Retrieve a document

`documents:read`

Create A Document`humaans_create_document`

Create a document

`documents:write`

Update A Document`humaans_update_document`

Update a document

`documents:write`

Delete A Document`humaans_delete_document`

Delete a document

`documents:write`

List All Emergency Contacts`humaans_list_emergency_contacts`

List all emergency contacts

`private:read`

Retrieve An Emergency Contact`humaans_get_emergency_contact`

Retrieve an emergency contact

`private:read`

Create An Emergency Contact`humaans_create_emergency_contact`

Create an emergency contact

`private:write`

Update An Emergency Contact`humaans_update_emergency_contact`

Update an emergency contact

`private:write`

Delete An Emergency Contact`humaans_delete_emergency_contact`

Delete an emergency contact

`private:write`

List All Equipment`humaans_list_equipment`

List all equipment

`private:read`

Retrieve An Equipment`humaans_get_equipment`

Retrieve an equipment

`private:read`

Create An Equipment`humaans_create_equipment`

Create an equipment

`private:write`

Update An Equipment`humaans_update_equipment`

Update an equipment

`private:write`

Delete An Equipment`humaans_delete_equipment`

Delete an equipment

`private:write`

Upload A File`humaans_create_file`

Upload a file

`documents:write`

Retrieve A File`humaans_get_file`

Retrieve a file

List All Equipment Names`humaans_list_equipment_names`

List all equipment names

`private:read`

List All Equipment Types`humaans_list_equipment_types`

List all equipment types

`private:read`

List All Identity Document Types`humaans_list_identity_document_types`

List all identity document types

`documents:read`

List All Identity Documents`humaans_list_identity_documents`

List all identity documents

`documents:read`

Retrieve An Identity Document`humaans_get_identity_document`

Retrieve an identity document

`documents:read`

Create An Identity Document`humaans_create_identity_document`

Create an identity document

`documents:write`

Update An Identity Document`humaans_update_identity_document`

Update an identity document

`documents:write`

Delete An Identity Document`humaans_delete_identity_document`

Delete an identity document

`documents:write`

List All Job Roles`humaans_list_job_roles`

List all job roles

`public:read`

Retrieve A Job Role`humaans_get_job_role`

Retrieve a job role

`public:read`

Create A Job Role`humaans_create_job_role`

Create a job role

`private:write`

Update A Job Role`humaans_update_job_role`

Update a job role

`private:write`

Delete A Job Role`humaans_delete_job_role`

Delete a job role

`private:write`

List All Locations`humaans_list_locations`

List all locations

`public:read`

Retrieve A Location`humaans_get_location`

Retrieve a location

`public:read`

Create A Location`humaans_create_location`

Create a location

`private:write`

Update A Location`humaans_update_location`

Update a location

`private:write`

Delete A Location`humaans_delete_location`

Delete a location

`private:write`

Retrieve Me`humaans_get_me`

Retrieve me

`public:read`

List All People`humaans_list_people`

List all people

`public:read`

Retrieve A Person`humaans_get_person`

Retrieve a person

`public:read`

Create A Person`humaans_create_person`

Create a person

`private:write`

Update A Person`humaans_update_person`

Update a person

`private:write`

Delete A Person`humaans_delete_person`

Delete a person

`private:write`

List All Public Holiday Calendars`humaans_list_public_holiday_calendars`

List all public holiday calendars

`public:read`

List All Public Holidays`humaans_list_public_holidays`

List all public holidays

`public:read`

List All Spaces`humaans_list_spaces`

List all spaces

`public:read`

Retrieve A Space`humaans_get_space`

Retrieve a space

`public:read`

Create A Space`humaans_create_space`

Create a space

`private:write`

Update A Space`humaans_update_space`

Update a space

`private:write`

Delete A Space`humaans_delete_space`

Delete a space

`private:write`

List All Time Away`humaans_list_time_away`

List all time away

`public:read`

Retrieve A Time Away`humaans_get_time_away`

Retrieve a time away

`public:read`

Create A Time Away`humaans_create_time_away`

Create a time away

`private:write`

Update A Time Away`humaans_update_time_away`

Update a time away

`private:write`

Delete A Time Away`humaans_delete_time_away`

Delete a time away

`private:write`

List All Time Away Adjustments`humaans_list_time_away_adjustments`

List all time away adjustments

`private:read`

Retrieve A Time Away Adjustment`humaans_get_time_away_adjustment`

Retrieve a time away adjustment

`private:read`

Create A Time Away Adjustment`humaans_create_time_away_adjustment`

Create a time away adjustment

`private:write`

Update A Time Away Adjustment`humaans_update_time_away_adjustment`

Update a time away adjustment

`private:write`

Delete A Time Away Adjustment`humaans_delete_time_away_adjustment`

Delete a time away adjustment

`private:write`

List All Time Away Allocations`humaans_list_time_away_allocations`

List all time away allocations

`private:read`

Retrieve A Time Away Allocation`humaans_get_time_away_allocation`

Retrieve a time away allocation

`private:read`

Create A Time Away Allocation`humaans_create_time_away_allocation`

Create a time away allocation

`private:write`

Update A Time Away Allocation`humaans_update_time_away_allocation`

Update a time away allocation

`private:write`

Delete A Time Away Allocation`humaans_delete_time_away_allocation`

Delete a time away allocation

`private:write`

List All Time Away Periods`humaans_list_time_away_periods`

List all time away periods

`private:read`

List All Time Away Policies`humaans_list_time_away_policies`

List all time away policies

`public:read`

Retrieve A Time Away Policy`humaans_get_time_away_policy`

Retrieve a time away policy

`public:read`

Create A Time Away Policy`humaans_create_time_away_policy`

Create a time away policy

`private:write`

Update A Time Away Policy`humaans_update_time_away_policy`

Update a time away policy

`private:write`

Delete A Time Away Policy`humaans_delete_time_away_policy`

Delete a time away policy

`private:write`

List All Time Away Types`humaans_list_time_away_types`

List all time away types

`public:read`

Retrieve A Time Away Type`humaans_get_time_away_type`

Retrieve a time away type

`public:read`

Create A Time Away Type`humaans_create_time_away_type`

Create a time away type

`private:write`

Update A Time Away Type`humaans_update_time_away_type`

Update a time away type

`private:write`

Delete A Time Away Type`humaans_delete_time_away_type`

Delete a time away type

`private:write`

List All Timesheet Entries`humaans_list_timesheet_entries`

List all timesheet entries

`private:read`

Retrieve A Timesheet Entry`humaans_get_timesheet_entry`

Retrieve a timesheet entry

`private:read`

Create A Timesheet Entry`humaans_create_timesheet_entry`

Create a timesheet entry

`private:write`

Update A Timesheet Entry`humaans_update_timesheet_entry`

Update a timesheet entry

`private:write`

Delete A Timesheet Entry`humaans_delete_timesheet_entry`

Delete a timesheet entry

`private:write`

List All Timesheet Submissions`humaans_list_timesheet_submissions`

List all timesheet submissions

`private:read`

Retrieve A Timesheet Submission`humaans_get_timesheet_submission`

Retrieve a timesheet submission

`private:read`

Create A Timesheet Submission`humaans_create_timesheet_submission`

Create a timesheet submission

`private:write`

Update A Timesheet Submission`humaans_update_timesheet_submission`

Update a timesheet submission

`private:write`

Delete A Timesheet Submission`humaans_delete_timesheet_submission`

Delete a timesheet submission

`private:write`

Retrieve My Token Info`humaans_get_token_info`

Retrieve my token info

List All Webhooks`humaans_list_webhooks`

List all webhooks

`webhooks:manage`

Retrieve A Webhook`humaans_get_webhook`

Retrieve a webhook

`webhooks:manage`

Create A Webhook`humaans_create_webhook`

Create a webhook

`webhooks:manage`

Update A Webhook`humaans_update_webhook`

Update a webhook

`webhooks:manage`


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.