API Reference

Authentication

Acquiring your API Key

In order to use our public API, you will need to use the HR:Duo platform to generate a public API key.

To generate an API key, you must have the Manage Public API permission.

  • Click on the settings cog ⚙️ and select Company Settings
  • Navigate to Public API in the left-hand menu.
  • Click Add New API Key and give it a meaningful name (e.g., its purpose).
  • Copy and store the generated API key securely—it will not be shown again.

You should include the API key as the authorization header with each request you make.

Example:

Authorization: Bearer {your-api-key}

Note: Your api key can be used to retrieve personal information about all staff in your company. Please handle it securely.