cURL
pcall GET "/api/v1/partner/skills/search?q=forklift&limit=10"const res = await call("GET", "/api/v1/partner/skills/search?q=forklift&limit=10");
const { data } = await res.json();res = call("GET", "/api/v1/partner/skills/search?q=forklift&limit=10")
data = res.json()["data"]<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-bc.userecord.io/api/v1/partner/skills/search",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>",
"x-secret-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api-bc.userecord.io/api/v1/partner/skills/search"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("x-secret-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api-bc.userecord.io/api/v1/partner/skills/search")
.header("x-api-key", "<api-key>")
.header("x-secret-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-bc.userecord.io/api/v1/partner/skills/search")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
request["x-secret-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"query": "forklift",
"count": 2,
"items": [
{
"skill_id": "sk_5177",
"name": "Forklift Truck",
"sub_domain": {
"id": "sub_architecture_and_construction__heavy_equipment_operation",
"name": "Heavy Equipment Operation"
},
"domain": {
"id": "dom_architecture_and_construction",
"name": "Architecture and Construction"
},
"collar": "white",
"verifiable": true
},
{
"skill_id": "sk_5176",
"name": "Forklift Safety",
"sub_domain": {
"id": "sub_architecture_and_construction__heavy_equipment_operation",
"name": "Heavy Equipment Operation"
},
"domain": {
"id": "dom_architecture_and_construction",
"name": "Architecture and Construction"
},
"collar": "white",
"verifiable": true
}
]
}
}{
"success": false,
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": [
{
"path": "<string>",
"message": "<string>"
}
],
"request_id": "<string>"
}
}{
"success": false,
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": [
{
"path": "<string>",
"message": "<string>"
}
],
"request_id": "<string>"
}
}Skills
Search skills
Type-ahead: find skills by a few letters (e.g. “fork”) and keep the skill_id the recruiter picks.
Scope: skills:read
GET
/
skills
/
search
cURL
pcall GET "/api/v1/partner/skills/search?q=forklift&limit=10"const res = await call("GET", "/api/v1/partner/skills/search?q=forklift&limit=10");
const { data } = await res.json();res = call("GET", "/api/v1/partner/skills/search?q=forklift&limit=10")
data = res.json()["data"]<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-bc.userecord.io/api/v1/partner/skills/search",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>",
"x-secret-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api-bc.userecord.io/api/v1/partner/skills/search"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("x-secret-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api-bc.userecord.io/api/v1/partner/skills/search")
.header("x-api-key", "<api-key>")
.header("x-secret-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-bc.userecord.io/api/v1/partner/skills/search")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
request["x-secret-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"query": "forklift",
"count": 2,
"items": [
{
"skill_id": "sk_5177",
"name": "Forklift Truck",
"sub_domain": {
"id": "sub_architecture_and_construction__heavy_equipment_operation",
"name": "Heavy Equipment Operation"
},
"domain": {
"id": "dom_architecture_and_construction",
"name": "Architecture and Construction"
},
"collar": "white",
"verifiable": true
},
{
"skill_id": "sk_5176",
"name": "Forklift Safety",
"sub_domain": {
"id": "sub_architecture_and_construction__heavy_equipment_operation",
"name": "Heavy Equipment Operation"
},
"domain": {
"id": "dom_architecture_and_construction",
"name": "Architecture and Construction"
},
"collar": "white",
"verifiable": true
}
]
}
}{
"success": false,
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": [
{
"path": "<string>",
"message": "<string>"
}
],
"request_id": "<string>"
}
}{
"success": false,
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": [
{
"path": "<string>",
"message": "<string>"
}
],
"request_id": "<string>"
}
}Authorizations
Your key id, VFN_TEST_… or VFN_LIVE_…. Sent on every request.
Your secret, VFN_SK_…. Not a real header, and never sent to the API. It is only a form field for Try it, which uses it to sign your request in your browser. In your own code you sign each request with the secret and send x-api-key, x-timestamp and x-signature (see Authentication).
Query Parameters
2 to 60 characters; matches the start of words, tolerates small typos
Required string length:
2 - 60Ranks this collar first; does not hide the others
Available options:
blue, grey, white Pattern:
^[a-z0-9_]{3,200}$Pattern:
^[a-z0-9_]{3,200}$1 to 20, default 10
Required range:
1 <= x <= 20
