MyCVHub API allows you to seamlessly integrate candidate search functionality into your own system or third-party applications. With our API, you can easily source and retrieve candidate data that matches your business requirements.
This article provides an overview of how to use MyCVHub API to search for candidates.
Base Endpoints
Use the following endpoints to perform candidate searches:
- https://mycvhub.co.za/api/candidates/?query=search_term
- https://mycvhub.co.za/api/candidates/?search=search_term
Replace search_term with your desired keyword (for example, a job title).
Available Search Filters
| Parameter | Description |
|---|---|
| job_title | Filter candidates by job title |
| job_category | Filter by job category or industry |
| years_of_experience | Filter by total years of experience |
| skills | Filter candidates based on specific skills |
| education | Filter by educational background |
| location | Filter by candidate location |
Authorization
All requests must include a valid Authorization Token in the request header.
Example using cURL:
curl -H "Authorization: Token 12345" "https://mycvhub.co.za/api/candidates/?search=example"
Example using Windows PowerShell:
Invoke-WebRequest -Uri "https://mycvhub.co.za/api/candidates/?search=Example" -Headers @{Authorization="Token 12345"}
Replace 12345 with your personal API Token, which can be found in your API Dashboard. If the Authorization header is missing or invalid, the API will return an authentication error.
Including Multiple Search Parameters
You can refine results by combining multiple search filters in a single query. Below are a few examples;
- https://mycvhub.co.za/api/candidates/?search=developer&location=Cape+Town&skills=Accounting,Finance
- https://mycvhub.co.za/api/candidates/?search=engineer&job_category=Engineering&years_of_experience=5
- https://mycvhub.co.za/api/candidates/?search=manager&education=MBA&location=Johannesburg
Each request will return a JSON response containing a list of matching candidates.