Postman Collection

Import our pre-configured Postman collection to quickly test HireCharacter API endpoints.

Download Collection

Get the complete HireCharacter API Postman collection with all endpoints, request examples, and environment variables pre-configured.

Download Collection Download Environment
Quick Import

Import directly into Postman using the Run in Postman button:

Run in Postman
Opens Postman desktop app or web version

Import Instructions

Step 1: Import Collection
  1. Open Postman application
  2. Click the "Import" button in the top left
  3. Drag and drop the downloaded HireCharacter-API-Collection.json file
  4. Click "Import" to confirm
Alternatively, you can copy the collection URL and paste it directly into Postman's import dialog.
Step 2: Import Environment
  1. Click the gear icon (⚙️) in the top right of Postman
  2. Select "Import" next to Environments
  3. Import the HireCharacter-Environment.json file
  4. Select "HireCharacter" environment from the dropdown
Step 3: Configure API Key
  1. In the environment variables, find api_key
  2. Set the "Current Value" to your actual API key
  3. Save the environment
Security Note: Never commit your actual API key to version control. The environment file contains placeholder values only.

Collection Contents

Authentication
  • API Key Setup
  • Bearer Token Examples
User Management
  • Create User
  • Get User Profile
  • Update User
  • List Users
Assessments
  • Create Assessment
  • Get Results
  • List Assessments
Signals & Reports
  • Submit Signal
  • Search Signals
  • Generate Report
Matching Engine
  • Find Matches
  • Get Match Details
  • Compatibility Scores
Webhooks
  • Register Webhook
  • Test Endpoint
  • Event Examples

Pre-configured Variables

The environment file includes the following pre-configured variables:

Variable Description Default Value
base_url API base URL https://api.hirecharacter.ai/v1
api_key Your API key YOUR_API_KEY_HERE
user_id Sample user ID for testing usr_sample_123
candidate_id Sample candidate ID cnd_sample_456
assessment_id Sample assessment ID ast_sample_789
Pro Tips
  • Use the "Tests" tab in requests to automatically set variables from responses
  • Enable request/response logging to debug API calls
  • Use the collection runner for automated testing sequences
  • Fork the collection to customize it for your specific use case
Collection Features
  • 50+ Pre-built Requests
  • Environment Variables
  • Example Payloads
  • Response Validation
  • Auto-generated Tests
  • Documentation Sync
Version Info
Collection Version: 2.1.0
API Version: v1
Last Updated: January 15, 2025
Postman Version: 10.0+
Need Help?

Having trouble with the Postman collection?

Contact Support Postman Docs Code Examples