GET/matches/:jdId

Get Match Results

Get all applications for a JD with AI scores, ranked by score descending. Includes candidate name, email, and application status.

🔒 Scope required: read or match:read

Path Parameters

Parameter	Type	Required	Description
`jdId`	string	✅	The job description ID

Example

curl https://api.scootsign.com/api/v1/matches/jd_abc123 \
  -H "X-API-Key: aram_ent_a1b2c3d4e5f6..."

Response

{
  "success": true,
  "data": [
    {
      "applicationId": "app_1",
      "resumeId": "res_abc123",
      "candidate": "John Doe",
      "email": "john@example.com",
      "aiScore": 92.5,
      "status": "SHORTLISTED"
    },
    {
      "applicationId": "app_2",
      "resumeId": "res_def456",
      "candidate": "Jane Smith",
      "email": "jane@example.com",
      "aiScore": 87.3,
      "status": "SCREENING"
    },
    {
      "applicationId": "app_3",
      "resumeId": "res_ghi789",
      "candidate": "Ravi Kumar",
      "email": "ravi@example.com",
      "aiScore": 74.1,
      "status": "SCREENING"
    }
  ]
}

Response Fields

Field	Type	Description
`applicationId`	string	Unique application identifier
`resumeId`	string	The resume ID for this candidate
`candidate`	string \| null	Candidate’s full name (if available)
`email`	string \| null	Candidate’s email
`aiScore`	number \| null	AI match score (0-100). `null` if not yet scored.
`status`	string	Application status: `SCREENING`, `SHORTLISTED`, `REJECTED`, `HIRED`

Errors

Status	Error
`404`	JD not found (wrong ID or doesn’t belong to your tenant)

Notes

Results include all applications, not just scored ones. Applications without AI scores have aiScore: null.
To trigger AI scoring, use the Aram dashboard or run matching via the web app. The API currently provides read-only access to results.