Get Job Family Profile Data

curl --request GET \
  --url https://{tenant_name}.{region}.techwolf.ai/job_architecture/job_families/{job_family_external_id}/profile_data/{job_family_profile_data_external_id} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://{tenant_name}.{region}.techwolf.ai/job_architecture/job_families/{job_family_external_id}/profile_data/{job_family_profile_data_external_id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{tenant_name}.{region}.techwolf.ai/job_architecture/job_families/{job_family_external_id}/profile_data/{job_family_profile_data_external_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{tenant_name}.{region}.techwolf.ai/job_architecture/job_families/{job_family_external_id}/profile_data/{job_family_profile_data_external_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$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://{tenant_name}.{region}.techwolf.ai/job_architecture/job_families/{job_family_external_id}/profile_data/{job_family_profile_data_external_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://{tenant_name}.{region}.techwolf.ai/job_architecture/job_families/{job_family_external_id}/profile_data/{job_family_profile_data_external_id}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{tenant_name}.{region}.techwolf.ai/job_architecture/job_families/{job_family_external_id}/profile_data/{job_family_profile_data_external_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "external_id": "a3903505-eb84-42dc-a79f-5e7b1fe897b7",
  "data_type": "job_family_description",
  "timestamp": "2025-05-02",
  "source": "Workday",
  "data": {
    "job_family_description": "Software engineers are responsible for designing, developing, and testing software. They are involved in the entire software development process, from the initial specification of requirements to the final release of the software."
  }
}

[
  {
    "title": "401 Unauthorized",
    "description": "OAuth access token is missing, invalid or expired."
  }
]

[
  {
    "title": "403 Forbidden",
    "description": "You don't have access to this resource."
  }
]

[
  {
    "title": "404 Not Found",
    "description": "Unknown external_id describing this resource. Please create this resource first."
  }
]

[
  {
    "title": "405 Method Not Allowed",
    "description": "This method is not allowed for the requested URL."
  }
]

max connections reached: <limit>

[
  {
    "title": "503 Service Unavailable",
    "description": "The Skill Engine API is currently not available. Please contact TechWolf or try again later."
  }
]

Get Job Family Profile Data

curl --request GET \
  --url https://{tenant_name}.{region}.techwolf.ai/job_architecture/job_families/{job_family_external_id}/profile_data/{job_family_profile_data_external_id} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://{tenant_name}.{region}.techwolf.ai/job_architecture/job_families/{job_family_external_id}/profile_data/{job_family_profile_data_external_id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{tenant_name}.{region}.techwolf.ai/job_architecture/job_families/{job_family_external_id}/profile_data/{job_family_profile_data_external_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{tenant_name}.{region}.techwolf.ai/job_architecture/job_families/{job_family_external_id}/profile_data/{job_family_profile_data_external_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$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://{tenant_name}.{region}.techwolf.ai/job_architecture/job_families/{job_family_external_id}/profile_data/{job_family_profile_data_external_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://{tenant_name}.{region}.techwolf.ai/job_architecture/job_families/{job_family_external_id}/profile_data/{job_family_profile_data_external_id}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{tenant_name}.{region}.techwolf.ai/job_architecture/job_families/{job_family_external_id}/profile_data/{job_family_profile_data_external_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "external_id": "a3903505-eb84-42dc-a79f-5e7b1fe897b7",
  "data_type": "job_family_description",
  "timestamp": "2025-05-02",
  "source": "Workday",
  "data": {
    "job_family_description": "Software engineers are responsible for designing, developing, and testing software. They are involved in the entire software development process, from the initial specification of requirements to the final release of the software."
  }
}

[
  {
    "title": "401 Unauthorized",
    "description": "OAuth access token is missing, invalid or expired."
  }
]

[
  {
    "title": "403 Forbidden",
    "description": "You don't have access to this resource."
  }
]

[
  {
    "title": "404 Not Found",
    "description": "Unknown external_id describing this resource. Please create this resource first."
  }
]

[
  {
    "title": "405 Method Not Allowed",
    "description": "This method is not allowed for the requested URL."
  }
]

max connections reached: <limit>

[
  {
    "title": "503 Service Unavailable",
    "description": "The Skill Engine API is currently not available. Please contact TechWolf or try again later."
  }
]

Authorizations

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

Scopes

read

allows reading resources

Path Parameters

job_family_external_id

string<uuid>

required

Unique ID linked to a Job Family, consisting of alphanumeric characters, hyphens and underscores. The unique ID in your system, consisting of alphanumeric characters, hyphens and underscores.

Required string length: 1 - 100

Pattern: [a-zA-Z0-9_-]+

Example:

"a3903505-eb84-42dc-a79f-5e7b1fe897b7"

job_family_profile_data_external_id

string<uuid>

required

Unique ID linked to a Job Family Profile Data, consisting of alphanumeric characters, hyphens and underscores. The unique ID in your system, consisting of alphanumeric characters, hyphens and underscores.

Required string length: 1 - 100

Pattern: [a-zA-Z0-9_-]+

Example:

"a3903505-eb84-42dc-a79f-5e7b1fe897b7"

Response

Default structure for Job Family Profile Data.

external_id

string<uuid>

required

The unique ID in your system, consisting of alphanumeric characters, hyphens and underscores.

Required string length: 1 - 100

Pattern: [a-zA-Z0-9_-]+

Example:

"a3903505-eb84-42dc-a79f-5e7b1fe897b7"

data_type

enum<string>

required

Type of the Job Family Profile Data.

Available options:

job_family_description,

skill_profile_feedback

Example:

"job_family_description"

timestamp

required

The completion date (in IS08601 format) of the Skill Event. From this point on, the Job Family Profile is considered to have obtained the Skills of this Event.

Example:

"2025-05-02"

source

string

required

The source of the Job Family Profile Data.

Required string length: 1 - 255

Example:

"Workday"

data

job_family_description_content · object

required

The content of the Job Family Profile Data. The content should align with the data_type.

job_family_description_content
job_family_description_file_content
skill_profile_feedback

Show child attributes

API Documentation

API Versioning

AI Integration

Taxonomy

Employees

Job Families

Jobs

Peer Groups

Vacancies

Courses

Skill Clusters

External Companies

Skills

Tasks

Organisational Structure

Custom Properties

Matchmaking

Matching Configuration

Export

Reports

Version

Get Job Family Profile Data

Authorizations

Scopes

Path Parameters

Response