Jump to Content

Guides API Endpoints API Changelog

API Endpoints

Guides API Endpoints API Changelog

All

Pages

Start typing to search…

API BASICS

🔑 Try your API Keysget
🔌 Find Workflows in a Workspaceget
✉️ Status codes
📖 Trait Objects

Profile API

📖 The Source Object
🔌 Find Sources in a Workspaceget
🔌 Get a Source from a Workspaceget
📖 The Profile Object
💾 Index a Profile in a Sourcepost
💾 Edit a Profile indexed in a Sourceput
💾 Get a Profile indexed in a Sourceget
💾 Find Profiles stored in Sourcesget
💾 Archive a Profile in a Sourcepatch
🧠 Parse a Resume in a Sourcepost
🧠 Get a Resume Parsing from a Sourceget
🧠 Ask questions to a Profile indexed in a Sourceget
🧠 Unfold the career path of a Profileget
🧠 Vectorize a Profilepost
🧠 Search Profiles indexed in Sourcesget
🧠 Score Profiles indexed in Sources for a Jobget
🧠 Match Profiles indexed in Sources to a Profileget
🧠 Grade Profiles indexed in a Source for a Jobget
🧠 Explain a Profile recommendation for a Jobget

Job API

📖 The Board Object
🔌 Find Boards in a Workspaceget
🔌 Get a Board from a Workspaceget
📖 The Job Object
💾 Index a Job in a Boardpost
💾 Edit a Job indexed in a Boardput
💾 Get a Job indexed in a Boardget
💾 Archive a Job in a Boardpatch
💾 Find Jobs stored in Boardsget
🧠 Ask questions to a Job indexed in a Boardget
🧠 Vectorize a Jobpost
🧠 Search Jobs indexed in Boardsget
🧠 Score Jobs indexed in Boards for a Profileget
🧠 Match Jobs indexed in Boards to a Jobget
🧠 Grade Jobs indexed in a Board for a Profileget
🧠 Explain a Job recommendation for a Profileget

Text API

🧠 Parse a raw Textpost
🧠 Tag a Textpost
🧠 Generate a job scene illustrationpost
🧠 Find Synonyms for a Wordpost
🧠 Geocode a location textpost
🧠 OCR a Textpost
🧠 Vectorize a Textpost

Signal API

⭐ [New] Rate a Profile or a Jobpost
⭐ [New] Get Ratingsget
⭐ [New] Track a Profile or a Jobpost
⭐ [New] Get Trackingsget

Useful Links

Help Center
Platform Status
Announcements
Public Roadmap

Powered by

✉️ Status codes

Understand HrFlow.ai success and error codes.