---
updatedAt: 2026-03-06T21:46:41.000Z
agentTools:
  projectIndex: https://developers.hrflow.ai/llms.txt
---

# 🔑 Try your API Keys

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](https://hrflow.ai/signup)
> 2. [🔑 Get your API Key](https://developers.hrflow.ai/docs/api-authentification)

## Request headers

<Table align={["left","left"]}>
  <thead>
    <tr>
      <th>
        Field
      </th>

      <th>
        Value
      </th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>
        <code>X-API-KEY</code>
      </td>

      <td>
        Your API Key.
      </td>
    </tr>

    <tr>
      <td>
        <code>X-USER-EMAIL</code>
      </td>

      <td>
        Your HrFlow\.ai account's email.
      </td>
    </tr>
  </tbody>
</Table>

## Response JSON

<Table align={["left","left","left"]}>
  <thead>
    <tr>
      <th>
        Field
      </th>

      <th>
        Type
      </th>

      <th>
        Description
      </th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>
        <code>team\_name</code>
      </td>

      <td>
        String
      </td>

      <td>
        Name of the team attached to the API Key.
      </td>
    </tr>

    <tr>
      <td>
        <code>team\_subdomain</code>
      </td>

      <td>
        String
      </td>

      <td>
        Subdomain of the team attached to the API Key.
      </td>
    </tr>

    <tr>
      <td>
        <code>request\_origin</code>
      </td>

      <td>
        String
      </td>

      <td>
        Domain origin of the request.
      </td>
    </tr>

    <tr>
      <td>
        <code>api\_key\_premission</code>
      </td>

      <td>
        String
      </td>

      <td>
        Level of permission of the API Key.
      </td>
    </tr>
  </tbody>
</Table>

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "website-api",
    "version": "2.3"
  },
  "servers": [
    {
      "url": "https://api.hrflow.ai/v1"
    }
  ],
  "components": {
    "securitySchemes": {
      "sec0": {
        "type": "apiKey",
        "in": "header",
        "name": "X-API-KEY",
        "x-default": ""
      },
      "sec1": {
        "type": "apiKey",
        "in": "header",
        "name": "X-USER-EMAIL"
      }
    }
  },
  "security": [
    {
      "sec0": [],
      "sec1": []
    }
  ],
  "paths": {
    "/auth": {
      "get": {
        "summary": "🔑 Try your API Keys",
        "description": "This endpoint allows you to learn how to add the right information to your API calls, so you can make them.",
        "operationId": "authentication",
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n  \"code\": 200,\n  \"message\": \"API Access Success\",\n  \"data\": {\n    \"team_name\": \"teslamotors\",\n    \"team_subdomain\": \"teslamotors\",\n    \"request_origin\": \"https://developers.hrflow.ai\",\n    \"api_secret_permission\": \"all\"\n  }\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "code": {
                      "type": "integer",
                      "example": 200,
                      "default": 0
                    },
                    "message": {
                      "type": "string",
                      "example": "API Access Success"
                    },
                    "data": {
                      "type": "object",
                      "properties": {
                        "team_name": {
                          "type": "string",
                          "example": "teslamotors"
                        },
                        "team_subdomain": {
                          "type": "string",
                          "example": "teslamotors"
                        },
                        "request_origin": {
                          "type": "string",
                          "example": "https://developers.hrflow.ai"
                        },
                        "api_secret_permission": {
                          "type": "string",
                          "example": "all"
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "401",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n  \"code\": 401,\n  \"message\": \"Unauthorized. Invalid secret key: ask_d3acf1d8eea48620e8907l95mc68260a for permission: all\"\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "code": {
                      "type": "integer",
                      "example": 401,
                      "default": 0
                    },
                    "message": {
                      "type": "string",
                      "example": "Unauthorized. Invalid secret key: ask_d3acf1d8eea48620e8907l95mc68260a for permission: all"
                    }
                  }
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true
}
```