Humaans API Directory

Humaans is a cutting-edge HRIS (Human Resource Information System) designed to revolutionize employee management for globally distributed companies. By offering a comprehensive suite of tools, Humaans simplifies the management of the entire employment lifecycle, from onboarding and promotions to offboarding and compensation management. This modern cloud platform is tailored to meet the needs of both small to medium-sized businesses (SMBs) and enterprise-level organizations, ensuring that HR teams can efficiently handle employee databases, payroll, time tracking, benefits, and other critical workforce data. With a focus on automation and streamlined workflows, Humaans significantly reduces administrative burdens, allowing HR professionals to focus on strategic initiatives.

One of the standout features of Humaans is its robust API integration capabilities, which enable seamless connectivity with various third-party applications. The Humaans API allows businesses to customize and extend the functionality of the platform, ensuring that it aligns perfectly with their unique operational requirements. By leveraging the Humaans API, organizations can enhance productivity and drive efficiency across their HR processes, making it an indispensable tool for modern HR management.

Key highlights of Humaans APIs

Humaans provides a RESTful API that enables developers to programmatically access and manage data within the Humaans platform. This API facilitates seamless integration with external applications, allowing operations such as retrieving employee information, managing documents, and handling time-off requests.

Humaans Docs

Key Features of the Humaans API:

  • Authentication: Utilizes API access tokens for secure authentication. Tokens are managed within the Humaans platform and should be included in the Authorization header as a Bearer token for each request.
  • Scopes and Roles: Access tokens can be restricted to specific scopes, limiting the actions they can perform. Roles assigned to users further define the level of access, ensuring that only authorized operations are executed.

Standardized Structure: The API features consistently structured, resource-oriented URLs, accepts and returns JSON-formatted data, and employs standard HTTP response codes and methods, facilitating straightforward integration.

Humaans API Endpoints

Time Away

  • DELETE https://api.example.com/time-away : Delete a time away
  • POST https://app.humaans.io/api/time-away : Create a Time Away Entry
  • PATCH https://app.humaans.io/api/time-away/{id} : Update a Time Away Entry
  • POST https://app.humaans.io/api/time-away-adjustments : Create a Time Away Adjustment
  • DELETE https://app.humaans.io/api/time-away-adjustments/{id} : Delete a Time Away Adjustment
  • POST https://app.humaans.io/api/time-away-allocations : Create a Time Away Allocation
  • GET https://app.humaans.io/api/time-away-allocations/{id} : Retrieve a Time Away Allocation
  • GET https://app.humaans.io/api/time-away-periods : List All Time Away Periods
  • GET https://app.humaans.io/api/time-away-policies : List All Time Away Policies
  • DELETE https://app.humaans.io/api/time-away-policies/{id} : Delete a Time Away Policy
  • POST https://app.humaans.io/api/time-away-types : Create a Time Away Type
  • GET https://app.humaans.io/api/time-away-types/{id} : Retrieve a Time Away Type

Bank Accounts

  • GET https://app.humaans.io/api/bank-accounts : List All Bank Accounts
  • DELETE https://app.humaans.io/api/bank-accounts/{id} : Delete a Bank Account

Companies

  • GET https://app.humaans.io/api/companies : List All Companies
  • PATCH https://app.humaans.io/api/companies/{id} : Update a Company

Compensations

  • POST https://app.humaans.io/api/compensations : Create a Compensation
  • DELETE https://app.humaans.io/api/compensations/{id} : Delete a Compensation

Custom Fields

  • GET https://app.humaans.io/api/custom-fields : List All Custom Fields
  • DELETE https://app.humaans.io/api/custom-fields/{id} : Delete a Custom Field

Custom Values

  • POST https://app.humaans.io/api/custom-values : Create a Custom Value
  • DELETE https://app.humaans.io/api/custom-values/{id} : Delete a Custom Value
  • PATCH https://app.humaans.io/api/custom-values{id} : Update a Custom Value

Data Exports

  • GET https://app.humaans.io/api/data-exports : Create a Data Export
  • GET https://app.humaans.io/api/data-exports/{id} : Retrieve a Data Export

Document Types

  • POST https://app.humaans.io/api/document-types : Create a Document Type
  • POST https://app.humaans.io/api/document-types/{id} : Update Document Type

Documents

  • GET https://app.humaans.io/api/documents : List All Documents
  • DELETE https://app.humaans.io/api/documents/{document_id} : Delete a Document
  • GET https://app.humaans.io/api/documents/{id} : Retrieve a Document

Emergency Contacts

  • GET https://app.humaans.io/api/emergency-contacts : List All Emergency Contacts
  • DELETE https://app.humaans.io/api/emergency-contacts/{id} : Delete an Emergency Contact

Equipment

  • POST https://app.humaans.io/api/equipment : Create Equipment
  • GET https://app.humaans.io/api/equipment-names : List All Equipment Names
  • GET https://app.humaans.io/api/equipment-types : List All Equipment Types
  • DELETE https://app.humaans.io/api/equipment/{id} : Delete an Equipment

Files

  • POST https://app.humaans.io/api/files : Create a File
  • GET https://app.humaans.io/api/files/{id} : Retrieve a File

Identity Documents

  • GET https://app.humaans.io/api/identity-document : List All Identity Documents
  • GET https://app.humaans.io/api/identity-document-types : List All Identity Document Types
  • POST https://app.humaans.io/api/identity-document/{id} : Create an Identity Document
  • DELETE https://app.humaans.io/api/identity-documents/{id} : Delete an Identity Document

Job Roles

  • POST https://app.humaans.io/api/job-roles : Create a Job Role
  • DELETE https://app.humaans.io/api/job-roles/{id} : Delete a Job Role

Locations

  • GET https://app.humaans.io/api/locations : List All Locations
  • PATCH https://app.humaans.io/api/locations/{id} : Update a Location

People

  • GET https://app.humaans.io/api/me/{id} : Retrieve Currently Logged In User
  • GET https://app.humaans.io/api/people : List All People
  • GET https://app.humaans.io/api/people/{id} : Retrieve a Person
  • GET and GET https://app.humaans.io/api/persons/{personId} and https:/app.humaans.io/api/companies/{companyId} : Retrieve Company Details Using Person's Company ID

Public Holidays

  • GET https://app.humaans.io/api/public-holiday-calendars : List all public holiday calendars
  • GET https://app.humaans.io/api/public-holidays : List all public holidays

Timesheets

  • GET https://app.humaans.io/api/timesheet-entries : List All Timesheet Entries
  • DELETE https://app.humaans.io/api/timesheet-entries/{id} : Delete a Timesheet Entry
  • GET https://app.humaans.io/api/timesheet-submissions : List All Timesheet Submissions
  • PATCH https://app.humaans.io/api/timesheet-submissions/{id} : Update a Timesheet Submission

Token Information

  • GET https://app.humaans.io/api/token-info/undefined : Retrieve Token Information

Humans API FAQs

How can I access the Humaans API?

  • Answer: To access the Humaans API, you need to generate an API token within your Humaans account. Navigate to the API section in your account settings to create a new token. This token will be used to authenticate your API requests.

What authentication method does the Humaans API use?

  • Answer: The Humaans API uses token-based authentication. After generating an API token, include it in the Authorization header of your HTTP requests, formatted as Bearer YOUR_API_TOKEN.

Are there rate limits for the Humaans API?

  • Answer: The official documentation does not specify explicit rate limits for the Humaans API. However, it's recommended to implement error handling for potential rate limiting responses to ensure robust integration.

Can I retrieve employee data using the Humaans API?

  • Answer: Yes, the Humaans API provides endpoints to retrieve employee data. For example, you can use the /employees endpoint to fetch a list of all employees, including their details such as names, roles, and contact information.

Does the Humaans API support webhooks for real-time data updates?

  • Answer: Yes, Humaans supports webhooks, allowing you to receive real-time notifications for specific events, such as employee updates or time-off requests. You can configure webhook subscriptions to specify which events you want to receive notifications for. Intercom

Get Started with Humaans API Integration

  1. Obtain API Access Tokens: Log in to your Humaans account to generate and manage API access tokens. Ensure these tokens are kept secure, as they grant significant access privileges.
  2. Set Appropriate Scopes: When creating access tokens, assign the necessary scopes to control the level of access, such as public:read for viewing public data or private:write for modifying private data.
  3. Understand API Endpoints: Familiarize yourself with the available endpoints, which cover resources like employees, documents, and time-off policies. Each resource supports standard operations (GET, POST, PATCH, DELETE) for data manipulation.
  4. Handle Pagination and Filtering: For endpoints that return lists of resources, implement pagination using parameters like $limit and $skip. Utilize filtering options to retrieve specific subsets of data as needed.

Additional Resources:

  • Comprehensive Documentation: Detailed API documentation is available, providing in-depth information on endpoints, authentication methods, and data structures.
  • Integration Support: Humaans offers guidance on integrating with various tools and platforms, enhancing the functionality of your HR operations.

About Knit

Knit API offers a convenient solution for quick and seamless integration with Humaans API. Our AI-powered integration platform allows you to build any Humaans API Integration use case. By integrating with Knit just once, you can integrate with multiple other CRM, Accounting, HRIS, ATS, and other systems in one go with a unified approach. Knit handles all the authentication, authorization, and ongoing integration maintenance. This approach saves time and ensures a smooth and reliable connection to Humaans API.‍

To sign up for free, click here. To check the pricing, see our pricing page.

#1 in Ease of Integrations

Trusted by businesses to streamline and simplify integrations seamlessly with GetKnit.