GuidesAPI EndpointsAPI Changelog
Live AI Demo
API Endpoints

💾 Get a Profile indexed in a Source

This endpoint allows retrieving the Profile object.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
📘

Prerequisites

  1. ✨ Create a Workspace
  2. 🔑 Get your API Key
  3. 🔌 Create a Source
  4. 💾 Index a Profile

Request headers

FieldValue
X-API-KEYYour API Key.
X-USER-EMAILYour HrFlow.ai account's email.
🚧

Query Parameters

The key and the reference cannot be null at the same time in the Query Parameters.

Query Params
string
required

The key of the Source associated to the profile.

string

The Profile unique identifier.

string

The Profile reference chosen by the customer.

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json