Skip to main content
GET
/
match
/
{jobId}
Get match results
curl --request GET \
  --url https://api-service.fribl.co/api/v1/match/{jobId} \
  --header 'x-api-key: <api-key>'
{
  "message": "<string>",
  "data": {}
}

Documentation Index

Fetch the complete documentation index at: https://docs.fribl.co/llms.txt

Use this file to discover all available pages before exploring further.

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

Match results for the specified job.

​
message
string
required
​
data
object
required

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