curl --request GET \
--url 'https://api.harmonyforstaffing.com/api/matching/jobs?candidateId=456' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"location": {
"zipCode": "94143",
"radius": 25,
"states": ["CA"],
"remote": true
},
"compensation": {
"minimum": 65.00,
"type": "hourly"
},
"schedule": {
"availableDate": "2024-06-01",
"shifts": ["day", "evening"],
"hoursPerWeek": {
"minimum": 32,
"maximum": 40
}
},
"jobTypes": ["full-time", "part-time"],
"specialties": ["icu", "er"],
"minScore": 70
}'
{
"jobs": [
{
"id": 123,
"title": "ICU Nurse",
"employer": {
"id": 456,
"name": "Saint Francis Hospital",
"location": {
"city": "San Francisco",
"state": "CA",
"zipCode": "94143"
}
},
"jobType": "full-time",
"schedule": {
"shifts": ["day", "night"],
"hoursPerWeek": {
"minimum": 36,
"maximum": 40
}
},
"compensation": {
"type": "hourly",
"minimum": 65.00,
"maximum": 85.00,
},
"screening": {
"currentScore": 85.5,
"potentialScore": 100,
"disqualify": false,
"summary": {
"screeningSummary": "Strong match for your ICU experience and certifications...",
"followUpQuestions": [
"Are you able to start on June 1st?",
"Are you comfortable with rotating shifts?"
],
"strengths": [
"Experience level exceeds requirements",
"All required certifications current"
],
"gaps": [
"Location is 30 miles from your preferred radius"
]
}
},
"requirements": {
"experience": "2+ years ICU",
"certifications": ["BLS", "ACLS", "PALS"],
"license": {
"type": "RN",
"state": "CA"
}
},
"postedDate": "2024-03-01T08:00:00Z",
"startDate": "2024-06-01"
}
],
"total": 45,
"limit": 20,
"offset": 0
}
Matching
Find Recommended Jobs
Find jobs that match a candidate’s qualifications and preferences
GET
/
api
/
matching
/
jobs
curl --request GET \
--url 'https://api.harmonyforstaffing.com/api/matching/jobs?candidateId=456' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"location": {
"zipCode": "94143",
"radius": 25,
"states": ["CA"],
"remote": true
},
"compensation": {
"minimum": 65.00,
"type": "hourly"
},
"schedule": {
"availableDate": "2024-06-01",
"shifts": ["day", "evening"],
"hoursPerWeek": {
"minimum": 32,
"maximum": 40
}
},
"jobTypes": ["full-time", "part-time"],
"specialties": ["icu", "er"],
"minScore": 70
}'
{
"jobs": [
{
"id": 123,
"title": "ICU Nurse",
"employer": {
"id": 456,
"name": "Saint Francis Hospital",
"location": {
"city": "San Francisco",
"state": "CA",
"zipCode": "94143"
}
},
"jobType": "full-time",
"schedule": {
"shifts": ["day", "night"],
"hoursPerWeek": {
"minimum": 36,
"maximum": 40
}
},
"compensation": {
"type": "hourly",
"minimum": 65.00,
"maximum": 85.00,
},
"screening": {
"currentScore": 85.5,
"potentialScore": 100,
"disqualify": false,
"summary": {
"screeningSummary": "Strong match for your ICU experience and certifications...",
"followUpQuestions": [
"Are you able to start on June 1st?",
"Are you comfortable with rotating shifts?"
],
"strengths": [
"Experience level exceeds requirements",
"All required certifications current"
],
"gaps": [
"Location is 30 miles from your preferred radius"
]
}
},
"requirements": {
"experience": "2+ years ICU",
"certifications": ["BLS", "ACLS", "PALS"],
"license": {
"type": "RN",
"state": "CA"
}
},
"postedDate": "2024-03-01T08:00:00Z",
"startDate": "2024-06-01"
}
],
"total": 45,
"limit": 20,
"offset": 0
}
Find and screen jobs that match a candidate’s qualifications and preferences. Results are automatically screened and ranked by match percentage.
Query Parameters
integer
required
ID of the candidate to find jobs for
Body Parameters
object
object
object
array
Types of positions (e.g., [“full-time”, “part-time”, “contract”, “per-diem”])
array
Preferred specialties (e.g., [“icu”, “er”, “pediatrics”])
number
default:"60"
Minimum match score (0-100)
integer
default:"20"
Maximum number of jobs to return
integer
default:"0"
Number of jobs to skip for pagination
curl --request GET \
--url 'https://api.harmonyforstaffing.com/api/matching/jobs?candidateId=456' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"location": {
"zipCode": "94143",
"radius": 25,
"states": ["CA"],
"remote": true
},
"compensation": {
"minimum": 65.00,
"type": "hourly"
},
"schedule": {
"availableDate": "2024-06-01",
"shifts": ["day", "evening"],
"hoursPerWeek": {
"minimum": 32,
"maximum": 40
}
},
"jobTypes": ["full-time", "part-time"],
"specialties": ["icu", "er"],
"minScore": 70
}'
Response Fields
array
Array of matching jobs with screening results
Show Job Object
Show Job Object
integer
Unique identifier for the job
string
Job title
object
string
Type of position (e.g., “full-time”, “part-time”)
object
object
object
Screening results for this job
Show Screening Object
Show Screening Object
number
Current match percentage based on verified criteria (0-100)
number
Maximum possible match percentage if all unverified criteria are met (0-100)
boolean
Whether the candidate should be disqualified from the job
object
Show Summary Object
Show Summary Object
string
Overall assessment of the candidate’s fit for the position
array
Questions to ask the candidate about unverified or unclear criteria
array
List of criteria that couldn’t be verified from available information
array
List of criteria where the candidate shows strong matches
array
List of areas where the candidate doesn’t meet requirements
array
Show Question Object
Show Question Object
integer
Unique identifier for the criterion
string
Origin of the criterion (e.g., “job_criteria”)
string
The criterion formatted as a question
string
Original criterion text
string
Type of criterion (e.g., “YearsOfExperience”, “Required”, “Preferred”)
string
Match status: “FullyMet”, “PartiallyMet”, or “NotMet”
string
Explanation of how the criterion was evaluated
string
Supporting text from resume/application, if found
object
string
When the job was posted (ISO 8601)
string
When the job starts (ISO 8601)
integer
Total number of matching jobs found
integer
Maximum number of jobs returned
integer
Number of jobs skipped
{
"jobs": [
{
"id": 123,
"title": "ICU Nurse",
"employer": {
"id": 456,
"name": "Saint Francis Hospital",
"location": {
"city": "San Francisco",
"state": "CA",
"zipCode": "94143"
}
},
"jobType": "full-time",
"schedule": {
"shifts": ["day", "night"],
"hoursPerWeek": {
"minimum": 36,
"maximum": 40
}
},
"compensation": {
"type": "hourly",
"minimum": 65.00,
"maximum": 85.00,
},
"screening": {
"currentScore": 85.5,
"potentialScore": 100,
"disqualify": false,
"summary": {
"screeningSummary": "Strong match for your ICU experience and certifications...",
"followUpQuestions": [
"Are you able to start on June 1st?",
"Are you comfortable with rotating shifts?"
],
"strengths": [
"Experience level exceeds requirements",
"All required certifications current"
],
"gaps": [
"Location is 30 miles from your preferred radius"
]
}
},
"requirements": {
"experience": "2+ years ICU",
"certifications": ["BLS", "ACLS", "PALS"],
"license": {
"type": "RN",
"state": "CA"
}
},
"postedDate": "2024-03-01T08:00:00Z",
"startDate": "2024-06-01"
}
],
"total": 45,
"limit": 20,
"offset": 0
}