This endpoint allows you to learn how to add the right information to your API calls, so you can make them.

📘

Prerequisites

  1. ✨ Create a Workspace
  2. 🔑 Get your API Key

Request headers

Field

Value

X-API-KEY

Your API Key.

X-USER-EMAIL

Your HrFlow.ai account's email.

Response JSON

Field

Type

Description

team_name

String

Name of the team attached to the API Key.

team_subdomain

String

Subdomain of the team attached to the API Key.

request_origin

String

Domain origin of the request.

api_key_premission

String

Level of permission of the API Key.

Language
Authentication
Click Try It! to start a request and see the response here!