Get match results

Retrieve previously computed match results for a specific job. Optionally specify a version number to access historical match results.

GET /match/{jobId}

Get match results

cURL

curl --request GET \
  --url https://api-service.fribl.co/api/v1/match/{jobId} \
  --header 'x-api-key: <api-key>'

200

{
  "message": "<string>",
  "data": {}
}

Authorizations

x-api-key · string · header · required

API key in UUID format. Include this header with every authenticated request.

Path Parameters

jobId · string<uuid> · required

Unique identifier of the job to retrieve match results for.

Query Parameters

version · integer

Specific version of match results to retrieve. If omitted, the latest version is returned.

Response

200

application/json

Match results for the specified job.

message · string · required

data · object · required

Stored match result for a job, including version information and scored candidates.