Public REST/JSON reference

Candidate Screening Score Card API

Scores candidates against role criteria, produces screening scorecards, and supports consistent candidate comparisons before interviews. Use this API to create role scorecards, score candidates from structured resume or application data, retrieve score details, and compare applicants with consistent weighting across screening criteria. Part of the Logic Igniter HR & Workforce Suite.

Access boundary

These examples describe public API calls only. Use the service output to review, score, summarize, analyze, or recommend; do not treat the API reference as permission for an assistant to write, send, publish, charge, schedule, notify, delete, or modify records.

Base URL

https://api.logicigniter.com

Auth

Authorization: Bearer YOUR_API_KEY

Version

OpenAPI 3.0.3 · 1.0.0

Spec

/api-specs/candidatescore.json

Operations rendered

Response models rendered

GET/api/v1/candidatescore/scorecards

List scorecards

Return screening scorecards for active roles.

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Parameters

Name	In	Type	Notes
`page_size`	query	integer
`page_token`	query	string

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X GET "https://api.logicigniter.com/api/v1/candidatescore/scorecards" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Responses

200Scorecards

Successful response

400Error

Invalid request payload or query parameter.

401Error

Missing, expired, or invalid bearer token.

402Error

Active HR & Workforce Suite subscription required.

404Error

Requested resource was not found for this workspace.

500Error

Unexpected service error.

POST/api/v1/candidatescore/scorecards

Create scorecard

Create a role-specific screening scorecard with weighted criteria.

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Request body (required)

Schema: CreateScorecardRequest

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X POST "https://api.logicigniter.com/api/v1/candidatescore/scorecards" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{}'

Responses

201Scorecard

Successful response

400Error

Invalid request payload or query parameter.

401Error

Missing, expired, or invalid bearer token.

402Error

Active HR & Workforce Suite subscription required.

404Error

Requested resource was not found for this workspace.

500Error

Unexpected service error.

GET/api/v1/candidatescore/scorecards/{id}

Get scorecard

Return criteria, weights, and scoring guidance for one scorecard.

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Parameters

Name	In	Type	Notes
`id`required	path	string

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X GET "https://api.logicigniter.com/api/v1/candidatescore/scorecards/:id" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Responses

200Scorecard

Successful response

400Error

Invalid request payload or query parameter.

401Error

Missing, expired, or invalid bearer token.

402Error

Active HR & Workforce Suite subscription required.

404Error

Requested resource was not found for this workspace.

500Error

Unexpected service error.

POST/api/v1/candidatescore/candidates/score

Score candidate

Score a candidate against a role scorecard and return screening rationale.

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Request body (required)

Schema: ScoreCandidateRequest

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X POST "https://api.logicigniter.com/api/v1/candidatescore/candidates/score" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{}'

Responses

200CandidateScore

Successful response

201CandidateScore

Successful response

400Error

Invalid request payload or query parameter.

401Error

Missing, expired, or invalid bearer token.

402Error

Active HR & Workforce Suite subscription required.

404Error

Requested resource was not found for this workspace.

500Error

Unexpected service error.

GET/api/v1/candidatescore/candidates/{id}/scores

Get candidate scores

Return score history for one candidate.

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Parameters

Name	In	Type	Notes
`id`required	path	string

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X GET "https://api.logicigniter.com/api/v1/candidatescore/candidates/:id/scores" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Responses

200CandidateScores

Successful response

400Error

Invalid request payload or query parameter.

401Error

Missing, expired, or invalid bearer token.

402Error

Active HR & Workforce Suite subscription required.

404Error

Requested resource was not found for this workspace.

500Error

Unexpected service error.

GET/api/v1/candidatescore/scores/{id}

Get score detail

Return one score result with criterion-level breakdown.

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Parameters

Name	In	Type	Notes
`id`required	path	string

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X GET "https://api.logicigniter.com/api/v1/candidatescore/scores/:id" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Responses

200CandidateScore

Successful response

400Error

Invalid request payload or query parameter.

401Error

Missing, expired, or invalid bearer token.

402Error

Active HR & Workforce Suite subscription required.

404Error

Requested resource was not found for this workspace.

500Error

Unexpected service error.

POST/api/v1/candidatescore/comparisons

Compare candidates

Compare scored candidates for a role and return rank-ordered strengths and gaps.

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Request body (required)

Schema: CompareCandidatesRequest

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X POST "https://api.logicigniter.com/api/v1/candidatescore/comparisons" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{}'

Responses

200CandidateComparison

Successful response

201CandidateComparison

Successful response

400Error

Invalid request payload or query parameter.

401Error

Missing, expired, or invalid bearer token.

402Error

Active HR & Workforce Suite subscription required.

404Error

Requested resource was not found for this workspace.

500Error

Unexpected service error.

Data models

Error

Field	Type	Notes
`code`required	string	Example: "invalid_request"
`message`required	string	Example: "The request body is missing a required field."
`request_id`	string	Example: "req_01HX7K9Z8W"

CandidateScore

Field	Type	Notes
`candidate_id`required	string	Example: "cand_742"
`role_id`required	string	Example: "role_senior_support"
`overall_score`required	integer	Example: 84
`recommendation`required	string	Example: "advance_to_interview"
`matched_criteria`required	integer	Example: 7
`missing_criteria`required	integer	Example: 2

CandidateScores

Field	Type	Notes
`items`required	array<CandidateScore>
`next_page_token`	string	Example: "eyJvZmZzZXQiOjI1fQ=="

ScoreCandidateRequest

Field	Type	Notes
`candidate_id`required	string	Example: "cand_742"
`role_id`required	string	Example: "role_senior_support"
`resume_text`required	string	Example: "Customer support leader with six years of SaaS escalation experience."
`application_answers`required	array<string>	Example: ["Managed Zendesk queue of 5,000 tickets/month","Led onboarding for new support hires"]

Scorecards

Field	Type	Notes
`items`required	array<object>
`next_page_token`	string	Example: null

Scorecard

CompareCandidatesRequest

Field	Type	Notes
`candidate_id`required	string	Example: "cand_742"
`role_id`required	string	Example: "role_senior_support"
`resume_text`required	string	Example: "Customer support leader with six years of SaaS escalation experience."
`application_answers`required	array<string>	Example: ["Managed Zendesk queue of 5,000 tickets/month","Led onboarding for new support hires"]

CreateScorecardRequest

Field	Type	Notes
`candidate_id`required	string	Example: "cand_742"
`role_id`required	string	Example: "role_senior_support"
`resume_text`required	string	Example: "Customer support leader with six years of SaaS escalation experience."
`application_answers`required	array<string>	Example: ["Managed Zendesk queue of 5,000 tickets/month","Led onboarding for new support hires"]