REST API/Matches
Matches
Match results, belonging probability tiers, and interest tracking.
9 endpoints
Endpoints
Endpoint Details
GET /matches/{match_id}
/matches/{match_id}JWTReturns match quality tier and belonging components. Access verified for the match member or organisation.
Path Parameters
| Name | Type | Description |
|---|---|---|
match_id* | string | Match UUID |
Response
{
"id": "d4e5f6a7-b8c9-0123-def4-567890abcdef",
"member_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"job_id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
"org_id": "e1f2a3b4-c5d6-7890-efab-cdef12345678",
"match_quality": "strong",
"match_status": "pending_review",
"computed_at": "2026-03-08T09:00:00Z"
}GET /matches/{match_id}/explanation
/matches/{match_id}/explanationJWTReturns human-readable match explanation with top strengths, growth areas, and belonging breakdown. Generates asynchronously if not cached (returns 202).
Path Parameters
| Name | Type | Description |
|---|---|---|
match_id* | string | Match UUID |
Response
{
"match_id": "d4e5f6a7-b8c9-0123-def4-567890abcdef",
"top_strengths": [
"Exceptional pressure response",
"Strong collaborative orientation"
],
"growth_areas": [
"Developing strategic thinking under ambiguity"
],
"belonging_breakdown": {
"authenticity": "high",
"acceptance": "strong",
"complementarity": "moderate"
},
"confidence_statement": "High confidence based on comprehensive identity data.",
"summary_text": "Strong alignment with the team culture, particularly in collaborative problem-solving."
}PUT /matches/{match_id}/status
/matches/{match_id}/statusJWTUpdate match status (organisation action). Requires org_admin or platform_admin role.
Path Parameters
| Name | Type | Description |
|---|---|---|
match_id* | string | Match UUID |
Request Example
{
"status": "org_interested"
}POST /matches/{match_id}/outcome
/matches/{match_id}/outcomeJWTRecord a placement outcome for the RL feedback loop. Requires org_admin or platform_admin role.
Path Parameters
| Name | Type | Description |
|---|---|---|
match_id* | string | Match UUID |
POST /matches/compute
/matches/computeJWTQueue match computation for a job (optionally for a specific member). Returns 202 Accepted with task ID.
Query Parameters
| Name | Type | Description |
|---|---|---|
job_id | string | Job UUID (required unless member_id provided) |
member_id | string | Member UUID (optional) |
GET /matches/member/{member_id}
/matches/member/{member_id}JWTList all matches for a member. Cursor-paginated. Members can view own; admins can view any.
Path Parameters
| Name | Type | Description |
|---|---|---|
member_id* | string | Member UUID |
Query Parameters
| Name | Type | Description |
|---|---|---|
status | string | Filter by match status |
limit | integer | Page size (max 100) |
cursor | string | Pagination cursor |
GET /matches/job/{job_id}
/matches/job/{job_id}JWTList all matches for a job. Cursor-paginated with quality and status filters. Org or admin access.
Path Parameters
| Name | Type | Description |
|---|---|---|
job_id* | string | Job UUID |
Query Parameters
| Name | Type | Description |
|---|---|---|
quality | string | Filter by match quality tier |
status | string | Filter by match status |
limit | integer | Page size (max 100) |
cursor | string | Pagination cursor |
POST /matches/{match_id}/feedback
/matches/{match_id}/feedbackJWTSubmit post-placement feedback at 30/90/180-day intervals. Both members and organisations can submit. One submission per respondent per stage.
Path Parameters
| Name | Type | Description |
|---|---|---|
match_id* | string | Match UUID |
GET /matches/{match_id}/feedback
/matches/{match_id}/feedbackJWTList all feedback records for a match. Accessible to match participants and admins.
Path Parameters
| Name | Type | Description |
|---|---|---|
match_id* | string | Match UUID |