curl --request GET \
  --url https://{tenant_name}.{region}.techwolf.ai/job_architecture/job_families \
  --header 'Authorization: Bearer <token>'
{
  "count": 3,
  "results": [
    {
      "external_id": "5cbdbdbe-5f44-4423-8157-520f8a2f429a",
      "active": true,
      "job_family_name": "Software Engineer",
      "job_family_group": "IT & Engineering"
    },
    {
      "external_id": "62d2c013-ab77-410e-b5fb-2f96eed9c1db",
      "active": true,
      "job_family_name": "Data Scientist",
      "job_family_group": "IT & Engineering"
    },
    {
      "external_id": "6129e3f1-663f-44ea-aa3f-2ce1077b834c",
      "active": true,
      "job_family_name": "Data Engineer",
      "job_family_group": "IT & Engineering"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
limit
integer
default:100

The maximal number of entities returned, ordered by the last_updated field and external_id.

Required range: 1 <= x <= 200
Example:

50

​
offset
integer
default:0

The applied offset for returned entities, results starting from offset up to offset + limit.

Required range: x >= 0
​
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

​
include
enum<string>[]

Additional entity attributes that will be included in the response body. This query parameter can be added multiple times to include more attributes.

Available options:
custom_properties
Example:
["custom_properties"]

Response

200
application/json
OK
​
count
integer
required

Total number of Job Family objects stored inside the system.

Required range: x >= 0
Example:

3

​
results
object[]
required

Subset of Job Families starting from offset up to offset + limit.

Default structure for Job Family.

Example:
[
  {
    "external_id": "5cbdbdbe-5f44-4423-8157-520f8a2f429a",
    "active": true,
    "job_family_name": "Software Engineer",
    "job_family_group": "IT & Engineering"
  },
  {
    "external_id": "62d2c013-ab77-410e-b5fb-2f96eed9c1db",
    "active": true,
    "job_family_name": "Data Scientist",
    "job_family_group": "IT & Engineering"
  },
  {
    "external_id": "6129e3f1-663f-44ea-aa3f-2ce1077b834c",
    "active": true,
    "job_family_name": "Data Engineer",
    "job_family_group": "IT & Engineering"
  }
]

Was this page helpful?