v1

latestOpenAPI 3.1.02026-07-26549156879.0 KB

JobCatalog > TreeNode

Reads all Tree nodes

Fetch Job Catalog Tree Node. For now only admins can see all the nodes' information, regular users won't have access to the nodes' information. In general there are four node types level, function, role and family.

get/api/2026-07-01/resources/job_catalog/tree_nodes

Query parameters

uuids[]string[]

List of Job Catalog node UUIDs to fetch. Must reference nodes of a single type.

[
  "jobcatalog_treelevel-331",
  "jobcatalog_treelevel-412"
]

node_type'jobcatalog_treeroot' | 'jobcatalog_treefamily' | 'jobcatalog_treefunction' | 'jobcatalog_treerole' | 'jobcatalog_treelevel' required

Node type scope for the query. Required with IDs, ancestor filters, or name search. Accepted values: jobcatalog_treelevel, jobcatalog_treefunction, jobcatalog_treerole, jobcatalog_treefamily.

Example:jobcatalog_treelevel

Node type scope for the query. Required with IDs, ancestor filters, or name search. Accepted values: jobcatalog_treelevel, jobcatalog_treefunction, jobcatalog_treerole, jobcatalog_treefamily.

ancestor_uuids[]string[]

Return nodes that descend from any of these ancestor UUIDs (single node type only).

[
  "jobcatalog_treefamily-018",
  "jobcatalog_treefamily-225"
]

include_full_pathboolean

When true, includes each node's ordered ancestor path up to the root.

Example:true

When true, includes each node's ordered ancestor path up to the root.

Response

Example response

{
  "data": [
    {
      "type": "jobcatalog_treelevel",
      "uuid": "jobcatalog_treelevel-331",
      "ancestor_uuid": "jobcatalog_treefamily-018",
      "name": "Engineering",
      "description": "Engineering Manager family",
      "created_at": "2024-01-15",
      "updated_at": "2024-01-15",
      "full_path_to_root": [
        "jobcatalog_treelevel-331",
        "jobcatalog_treerole-456",
        "jobcatalog_treefunction-123",
        "jobcatalog_treefamily-018",
        "jobcatalog_treeroot-1"
      ],
      "job_catalog_title": "Engineering Manager, Senior"
    }
  ]
}