API Access Guidelines and Request - HRIS

Jimmy De Santis
Jimmy De Santis
  • Updated

This guide provides all necessary information for accessing and utilizing the Folks HRIS API, ensuring a smooth integration process for your development needs.

1. API Access Options

Sandbox Environment

  • Ideal for Testing: Enables technical trials without compromising data security.
  • Fictitious Data: Only use non-real data to eliminate the risk of sensitive information leakage.
  • Shared Access: Designed for external developers and partners who require testing without access to real data.

Production Access

  • Real Integration: Allows integration with your actual data in Folks for operational use.
  • Enhanced Security: Requires heightened security measures to safeguard data confidentiality and integrity.

2. Request Procedure

To request your API key, please follow these steps:

  1. Environment Selection: Decide whether you need Sandbox access for testing or Production access.
  2. Terms Review: Familiarize yourself with our terms and conditions available here before submitting your request.
  3. Form Submission: Go to the request form, fill it out specifying the desired type of access and the necessary information.

3. Terms and Conditions

It's crucial to read and accept the terms and conditions before proceeding with your request. These terms govern the API's use, ensuring responsible and secure utilization. Detailed terms can be found at Folks HRIS Terms and Conditions.

4. Application Form Reminder

Do not forget to complete the application form to obtain your API key. This step is essential for starting your integration with the Folks HRIS environment. Access the form here and ensure all required information is provided for efficient processing of your request.

5. Excessive Use

In line with our API usage policy, clients are limited to a maximum of 60 requests per minute to ensure fair access and optimal performance for all users. Exceeding this limit may result in temporary blocking of your access, accompanied by a 403 Forbidden error response. This measure aims to prevent excessive usage that could impact service quality, and we encourage users to manage their request rate responsibly to avoid such restrictions.


Our support team is available to answer your questions and assist you in setting up your API integration. Please feel free to contact us for any further assistance.

Was this article helpful?

0 out of 0 found this helpful

Have more questions? Submit a request



Please sign in to leave a comment.