Skip to main content
GET
/
smart-match
/
{publicIdentifier}
/
{skillsetId}
Get Smart Match Results
curl --request GET \
  --url https://api.ever.day/smart-match/{publicIdentifier}/{skillsetId} \
  --header 'x-api-key: <api-key>'
{
  "name": "Teacher Skillset",
  "match": {
    "overall": 123,
    "knowledge": 123,
    "transversal": 123,
    "functional": 123
  },
  "skills": [
    {
      "id": "<string>",
      "name": "<string>",
      "requiredLevel": 123,
      "achievedLevel": 123,
      "type": "KNOWLEDGE",
      "description": "<string>"
    }
  ]
}

Authorizations

x-api-key
string
header
required

Include your API key in the x-api-key header to authenticate requests. Each organisation is provided with a unique API key. If your key is lost or compromised, contact support to request a new one.

Path Parameters

publicIdentifier
string
required

The external unique identifier.

skillsetId
string
required

The unique identifier of the skillset.

Response

Smart match results retrieved successfully.

name
string

The name of the skillset.

Example:

"Teacher Skillset"

match
object
skills
object[]

List of matched skills with qualification, proficiency, type, required and achieved levels, and description.