curl --request GET \
  --url https://{tenant_name}.{region}.techwolf.ai/job_architecture/export \
  --header 'Authorization: Bearer <token>'
{
  "job_family_groups": [
    {
      "job_family_group_name": "IT & Engineering",
      "low_data_availability": 123,
      "job_families": [
        {
          "external_id": "a3903505-eb84-42dc-a79f-5e7b1fe897b7",
          "job_family_name": "Mobile Development",
          "low_data_availability": 123,
          "jobs": [
            {
              "external_id": "a3903505-eb84-42dc-a79f-5d8b1fe897b7",
              "job_name": "Front End Developer",
              "low_data_availability": 123
            }
          ]
        }
      ]
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
is_active
boolean
default:None

This parameter can be used to only include entities with the active attribute set to true or false. If the parameter is not set, all entities will be included.

Example:

true

​
skill_id
string

The unique ID of a Skill, consisting of alphanumeric characters and hyphens. Setting this parameter will include only Job Families and Job Family Groups with Jobs that have this Skill in their Skill Profile.

Required string length: 1 - 100
Example:

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

​
include
enum<string>[]

When set to low_data_availability_flag, the response will include information about the total number of Jobs with low data availability within each Job Family or Job Family Group. For Jobs, this field is equal to 1 or 0 depending on whether the Job has low data availability.

Available options:
low_data_availability_flag
Example:
["low_data_availability_flag"]

Response

200
application/json
OK
​
job_family_groups
object[]
required

A list of Job Family Groups.

Was this page helpful?