This guide explains how to request and use your Folks HRIS API access. Two environments are available depending on your needs.
API Access Options
Sandbox
Test environment using fictitious data only. Ideal for developers and partners before moving to production.
Production
Access to your real data in Folks. Requires enhanced security measures and an approved request.
Request Procedure
- Choose your environment: Sandbox for testing, Production for live integration.
- Submit the request form specifying the type of access you need.
Once the feature is activated by Folks, an administrator can generate an API key via: Settings > Integrations > API Key Management
See also: Generate a Folks API Key
Security Considerations and Responsibilities
Once the API is activated, you can generate keys and define their permissions. These keys provide direct access to your data and must be handled with the same level of care as admin platform credentials.
As the platform operator, you are responsible for securing the generated keys as well as the administrator account used to create them. Any compromise of these accesses is your responsibility.
For the full terms of use: folksrh.com/termes-api
Excessive Usage
Clients are limited to 60 requests per minute. Exceeding this limit will result in a temporary block with a 403 Forbidden response.
If you have any questions, our support team is available to help.