Find Recommended 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
}

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

candidateId

integer

required

ID of the candidate to find jobs for

Body Parameters

location

object

Location preferences for job search

Show Location Object

zipCode

string

ZIP/Postal code to search from

radius

integer

default:"25"

Search radius in miles

states

array

List of state codes (e.g., [“CA”, “OR”, “WA”])

remote

boolean

Include remote positions

compensation

object

Compensation requirements

Show Compensation Object

minimum

number

Minimum annual salary or hourly rate

type

string

Pay type: “hourly” or “salary”

schedule

object

Schedule preferences

Show Schedule Object

availableDate

string

Date available to start (ISO 8601)

shifts

array

Preferred shifts (e.g., [“day”, “night”, “evening”])

hoursPerWeek

object

minimum

integer

Minimum hours per week

maximum

integer

Maximum hours per week

jobTypes

array

Types of positions (e.g., [“full-time”, “part-time”, “contract”, “per-diem”])

specialties

array

Preferred specialties (e.g., [“icu”, “er”, “pediatrics”])

minScore

number

default:"60"

Minimum match score (0-100)

limit

integer

default:"20"

Maximum number of jobs to return

offset

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

jobs

array

Array of matching jobs with screening results

Show Job Object

integer

Unique identifier for the job

title

string

Job title

employer

object

Employer information

Show Employer Object

integer

Unique identifier for the employer

name

string

Employer name

location

object

Show Location Object

city

string

City name

state

string

State code (e.g., “CA”)

zipCode

string

ZIP/Postal code

jobType

string

Type of position (e.g., “full-time”, “part-time”)

schedule

object

Schedule details

Show Schedule Object

shifts

array

Available shifts (e.g., [“day”, “night”])

hoursPerWeek

object

minimum

integer

Minimum hours per week

maximum

integer

Maximum hours per week

compensation

object

Compensation details

Show Compensation Object

type

string

Pay type (“hourly” or “salary”)

minimum

number

Minimum pay rate

maximum

number

Maximum pay rate

screening

object

Screening results for this job

Show Screening Object

currentScore

number

Current match percentage based on verified criteria (0-100)

potentialScore

number

Maximum possible match percentage if all unverified criteria are met (0-100)

disqualify

boolean

Whether the candidate should be disqualified from the job

summary

object

Show Summary Object

screeningSummary

string

Overall assessment of the candidate’s fit for the position

followUpQuestions

array

Questions to ask the candidate about unverified or unclear criteria

missingInformation

array

List of criteria that couldn’t be verified from available information

strengths

array

List of criteria where the candidate shows strong matches

gaps

array

List of areas where the candidate doesn’t meet requirements

questions

array

Show Question Object

integer

Unique identifier for the criterion

source

string

Origin of the criterion (e.g., “job_criteria”)

question

string

The criterion formatted as a question

criteria

string

Original criterion text

type

string

Type of criterion (e.g., “YearsOfExperience”, “Required”, “Preferred”)

status

string

Match status: “FullyMet”, “PartiallyMet”, or “NotMet”

reasoning

string

Explanation of how the criterion was evaluated

textEvidence

string

Supporting text from resume/application, if found

requirements

object

Job requirements

Show Requirements Object

experience

string

Experience requirements

certifications

array

Required certifications

license

object

type

string

License type (e.g., “RN”)

state

string

State code where license is required

postedDate

string

When the job was posted (ISO 8601)

startDate

string

When the job starts (ISO 8601)

total

integer

Total number of matching jobs found

limit

integer

Maximum number of jobs returned

offset

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
}

Get Screenings for Job Find Recommended Candidates

⌘I

Getting Started

API Reference

Query Parameters

Body Parameters

Response Fields

Getting Started

API Reference

​Query Parameters

​Body Parameters

​Response Fields

Query Parameters

Body Parameters

Response Fields