GET /jobs/<job_id>/search
x-api-key: YOUR_API_KEY
api_key=YOUR_API_KEY
Name | Type | Required | Description |
---|---|---|---|
job_id | string | ✅ Yes | The job ID from /jobs/create |
Name | Type | Required | Description |
---|---|---|---|
api_key | string | ✅ Yes | API key for authentication (can also be in x-api-key header) |
size | integer | ❌ No | Number of candidates to return. Default: 100 , Range: 1-1000 |
summary_length | integer | ❌ No | Length of generated summary. Default: 1024 , Range: 30-8192 |
countries | array | ❌ No | Filter by country codes (e.g., ['US', 'CA', 'UK'] ) |
segments | array | ❌ No | Filter by data segments (integers 0-9999 ) |
required_fields | array | ❌ No | Only return profiles containing these fields |
Header | Description |
---|---|
X-Credits-Used | Total credits used by your API key across all endpoints |
X-Credits-Used-Assess | Credits used specifically for assessment operations |
X-Credits-Remaining | Remaining credits (-1 for unlimited accounts) |
Status Code | Description |
---|---|
400 | Bad Request - Invalid parameters |
401 | Unauthorized - Missing API key |
403 | Forbidden - Invalid API key or access denied |
404 | Not Found - Job ID not found |
500 | Internal Server Error |
size
parameter to control result count vs. performancegithub_username
with: