Screen Many Candidates

curl --request POST \
  --url https://api.harmonyforstaffing.com/api/screening/batch \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
    "jobId": 123,
    "candidateIds": [456, 457, 458],
    "criteria": [
      {
        "description": "Must be experienced in Pediatric Intensive Care",
        "importance": "required",
        "type": "specialty"
      }
    ],
    "replaceCriteria": true
  }'

{
  "screenings": [
    {
      "id": 789,
      "candidateId": 456,
      "jobId": 123,
      "currentScore": 66.67,
      "potentialScore": 100,
      "disqualify": false,
      "criteria": [
        {
          "id": 1,
          "source": "job_criteria",
          "question": "How many years of ICU nursing experience do you have?",
          "criteria": "Minimum of 3 years ICU nursing experience required",
          "type": "YearsOfExperience",
          "status": "PartiallyMet",
          "reasoning": "The candidate has 2 years of ICU experience...",
          "textEvidence": "2 years of experience in Medical ICU"
        }
      ],
      "qualificationLevel": "Appropriate",
      "isRelevant": true
    }
    // ... Additional screening results
  ]
}

POST

api

screening

batch

curl --request POST \
  --url https://api.harmonyforstaffing.com/api/screening/batch \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
    "jobId": 123,
    "candidateIds": [456, 457, 458],
    "criteria": [
      {
        "description": "Must be experienced in Pediatric Intensive Care",
        "importance": "required",
        "type": "specialty"
      }
    ],
    "replaceCriteria": true
  }'

{
  "screenings": [
    {
      "id": 789,
      "candidateId": 456,
      "jobId": 123,
      "currentScore": 66.67,
      "potentialScore": 100,
      "disqualify": false,
      "criteria": [
        {
          "id": 1,
          "source": "job_criteria",
          "question": "How many years of ICU nursing experience do you have?",
          "criteria": "Minimum of 3 years ICU nursing experience required",
          "type": "YearsOfExperience",
          "status": "PartiallyMet",
          "reasoning": "The candidate has 2 years of ICU experience...",
          "textEvidence": "2 years of experience in Medical ICU"
        }
      ],
      "qualificationLevel": "Appropriate",
      "isRelevant": true
    }
    // ... Additional screening results
  ]
}

Screen multiple candidates against a job, including a summary of the screening results. You can optionally provide additional or replacement criteria specific to this screening.

Body Parameters

integer

Single candidate ID to screen against multiple jobs (required if jobIds provided)

integer

Single job ID to screen multiple candidates against (required if candidateIds provided)

array

Additional screening criteria (optional)

Show Criteria Object

string

required

Full description of the requirement (e.g., “Must have 2 years of ICU nursing experience”)

string

required

One of: “required”, “preferred”, “optional”

string

required

Type of criterion (e.g., “specialty”, “certification”, “experience”)

boolean

default:"false"

If true, provided criteria replace job criteria. If false, they are added to job criteria.

Request Examples

curl --request POST \
  --url https://api.harmonyforstaffing.com/api/screening/batch \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
    "jobId": 123,
    "candidateIds": [456, 457, 458],
    "criteria": [
      {
        "description": "Must be experienced in Pediatric Intensive Care",
        "importance": "required",
        "type": "specialty"
      }
    ],
    "replaceCriteria": true
  }'

Response Fields

integer

Unique identifier for the screening

integer

ID of the job submission being screened (if exists)

integer

ID of the candidate being screened

integer

ID of the job being screened against

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

array

Detailed analysis of each criterion

Show Criterion fields

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

string

Overall qualification assessment (e.g., “Appropriate”, “Overqualified”, “Underqualified”)

boolean

Indicates if the candidate’s background is relevant to the position

{
  "screenings": [
    {
      "id": 789,
      "candidateId": 456,
      "jobId": 123,
      "currentScore": 66.67,
      "potentialScore": 100,
      "disqualify": false,
      "criteria": [
        {
          "id": 1,
          "source": "job_criteria",
          "question": "How many years of ICU nursing experience do you have?",
          "criteria": "Minimum of 3 years ICU nursing experience required",
          "type": "YearsOfExperience",
          "status": "PartiallyMet",
          "reasoning": "The candidate has 2 years of ICU experience...",
          "textEvidence": "2 years of experience in Medical ICU"
        }
      ],
      "qualificationLevel": "Appropriate",
      "isRelevant": true
    }
    // ... Additional screening results
  ]
}

Getting Started

API Reference

Body Parameters

Request Examples

Response Fields

​Body Parameters

​Request Examples

​Response Fields

Body Parameters

Request Examples

Response Fields