Skip to main content
API Preview
Developers

REST API/Matches

Matches

Match results, belonging probability tiers, and interest tracking.

9 endpoints

Endpoints

MethodPathAuth
GET/matches/{match_id}

Get match details

JWT
GET/matches/{match_id}/explanation

Get match explanation

JWT
POST/matches/{match_id}/feedback

Submit placement feedback

JWT
GET/matches/{match_id}/feedback

Get placement feedback

JWT
POST/matches/{match_id}/outcome

Record placement outcome

JWT
PUT/matches/{match_id}/status

Update match status

JWT
POST/matches/compute

Trigger match computation

JWT
GET/matches/job/{job_id}

Get job matches

JWT
GET/matches/member/{member_id}

Get member matches

JWT

Endpoint Details

GET /matches/{match_id}

GET/matches/{match_id}JWT

Returns match quality tier and belonging components. Access verified for the match member or organisation.

Path Parameters

NameTypeDescription
match_id*stringMatch UUID

Response

json
{
  "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

GET/matches/{match_id}/explanationJWT

Returns human-readable match explanation with top strengths, growth areas, and belonging breakdown. Generates asynchronously if not cached (returns 202).

Path Parameters

NameTypeDescription
match_id*stringMatch UUID

Response

json
{
  "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

PUT/matches/{match_id}/statusJWT

Update match status (organisation action). Requires org_admin or platform_admin role.

Path Parameters

NameTypeDescription
match_id*stringMatch UUID

Request Example

json
{
  "status": "org_interested"
}

POST /matches/{match_id}/outcome

POST/matches/{match_id}/outcomeJWT

Record a placement outcome for the RL feedback loop. Requires org_admin or platform_admin role.

Path Parameters

NameTypeDescription
match_id*stringMatch UUID

POST /matches/compute

POST/matches/computeJWT

Queue match computation for a job (optionally for a specific member). Returns 202 Accepted with task ID.

Query Parameters

NameTypeDescription
job_idstringJob UUID (required unless member_id provided)
member_idstringMember UUID (optional)

GET /matches/member/{member_id}

GET/matches/member/{member_id}JWT

List all matches for a member. Cursor-paginated. Members can view own; admins can view any.

Path Parameters

NameTypeDescription
member_id*stringMember UUID

Query Parameters

NameTypeDescription
statusstringFilter by match status
limitintegerPage size (max 100)
cursorstringPagination cursor

GET /matches/job/{job_id}

GET/matches/job/{job_id}JWT

List all matches for a job. Cursor-paginated with quality and status filters. Org or admin access.

Path Parameters

NameTypeDescription
job_id*stringJob UUID

Query Parameters

NameTypeDescription
qualitystringFilter by match quality tier
statusstringFilter by match status
limitintegerPage size (max 100)
cursorstringPagination cursor

POST /matches/{match_id}/feedback

POST/matches/{match_id}/feedbackJWT

Submit post-placement feedback at 30/90/180-day intervals. Both members and organisations can submit. One submission per respondent per stage.

Path Parameters

NameTypeDescription
match_id*stringMatch UUID

GET /matches/{match_id}/feedback

GET/matches/{match_id}/feedbackJWT

List all feedback records for a match. Accessible to match participants and admins.

Path Parameters

NameTypeDescription
match_id*stringMatch UUID